Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document that YAML files are expected to be in YAML1.2 #1764

Merged
merged 6 commits into from
Oct 19, 2020
Merged

Document that YAML files are expected to be in YAML1.2 #1764

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c53f7e7
Document that YAML files are expected to be in YAML1.2
skshetry Sep 8, 2020
df9f615
remove note, embed the note in the paragraph
skshetry Sep 10, 2020
3f062ed
Apply suggestions from code review
skshetry Oct 19, 2020
283a00f
Restyled by prettier
restyled-commits Oct 19, 2020
d12bd39
Merge pull request #1875 from iterative/restyled/skshetry/yaml-1-2
skshetry Oct 19, 2020
4515fcc
Merge branch 'master' into skshetry/yaml-1-2
skshetry Oct 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions content/docs/command-reference/metrics/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,10 @@ stages:

### Supported file formats

Metrics can be organized as tree hierarchies in JSON or YAML files. DVC
addresses specific metrics by the tree path. In the JSON example below, five
metrics are presented: `train.accuracy`, `train.loss`, `train.TN`, `train.FP`
and `time_real`.
Metrics can be organized as tree hierarchies in JSON or YAML files (specifically
in YAML 1.2 format). DVC addresses specific metrics by the tree path. In the
JSON example below, five metrics are presented: `train.accuracy`, `train.loss`,
`train.TN`, `train.FP` and `time_real`.
skshetry marked this conversation as resolved.
Show resolved Hide resolved

```json
{
Expand Down
5 changes: 3 additions & 2 deletions content/docs/command-reference/params/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,9 @@ dependencies: _parameters_. Parameters are defined using the the `-p`

In contrast to a regular <abbr>dependency</abbr>, a parameter is not a file (or
directory). Instead, it consists of a _parameter name_ (or key) to find inside a
YAML, JSON, or TOML _parameters file_. Multiple parameter dependencies can be
specified from one or more parameters files.
YAML (specifically in YAML 1.2 format), JSON, or TOML _parameters file_.
skshetry marked this conversation as resolved.
Show resolved Hide resolved
Multiple parameter dependencies can be specified from one or more parameters
files.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same, just "YAML 1.2"? (Linked)

Copy link
Contributor

@jorgeorpinel jorgeorpinel Sep 23, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, there's several other files that include this params file formats list. Please see #1799 (review)

Copy link
Contributor

@jorgeorpinel jorgeorpinel Sep 23, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • In fact I'd just grep YAML (upper case and double check all instances (there's 28). DONE SEPARATELY

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's not change everywhere, it's enough to mention it in key areas. It's still YAML, so it's fine.

Copy link
Contributor

@jorgeorpinel jorgeorpinel Oct 9, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here, just Same, just "YAML 1.2" please.

it's enough to mention it in key areas

OK but why are the metrics/params index more important than docs/start/experiments or docs/user-guide/basic-concepts/parameter? (or other places)

Copy link
Contributor

@jorgeorpinel jorgeorpinel Oct 9, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In fact I'd just grep YAML (upper case and double check all instances

I didn't mean change it everywhere BTW, but we need to check all 28 instances please, and decide which ones to change. I think it should definitely be more than just this one

It's a simple change from YAML to "YAML 1.2".


The default parameters file name is `params.yaml`. Parameters should be
organized as a tree hierarchy inside, as DVC will locate param names by their
Expand Down
6 changes: 3 additions & 3 deletions content/docs/command-reference/plots/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ differences between the metrics in different experiments.

### Supported file formats

Plot metrics can be organized as data series in JSON, YAML, CSV, or TSV files.
DVC expects to see an array (or multiple arrays) of objects (usually _float
numbers_) in the file.
Plot metrics can be organized as data series in JSON, YAML (in YAML 1.2 format),
skshetry marked this conversation as resolved.
Show resolved Hide resolved
CSV, or TSV files. DVC expects to see an array (or multiple arrays) of objects
(usually _float numbers_) in the file.

In tabular file formats such as CSV and TSV, each column is an array.
`dvc plots` subcommands can produce plots for a specified column or a set of
Expand Down
6 changes: 3 additions & 3 deletions content/docs/user-guide/dvc-files-and-directories.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ Additionally, there are a few metafiles that support DVC's features:
These typically have a matching `dvc.lock` file to record the pipeline state
and track its <abbr>data artifacts</abbr>.

Both `.dvc` files and `dvc.yaml` use human-friendly YAML schemas, described
below. We encourage you to get familiar with them so you may create, generate,
and edit them on your own.
Both `.dvc` files and `dvc.yaml` use human-friendly YAML schemas (expected to be
in YAML 1.2 format), described below. We encourage you to get familiar with them
skshetry marked this conversation as resolved.
Show resolved Hide resolved
so you may create, generate, and edit them on your own.

Both the internal directory and these metafiles should be versioned with Git (in
Git-enabled <abbr>repositories</abbr>).
Expand Down