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.

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

metrics: now support TOML files #3724

Merged
merged 2 commits into from
Jul 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions content/docs/command-reference/metrics/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ stages:

### Supported file formats

Metrics can be organized as tree hierarchies in JSON or YAML 1.2 files. DVC
addresses specific metrics by the tree path. In the JSON example below, five
Metrics can be organized as tree hierarchies in JSON, TOML, or YAML 1.2 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`.

Expand Down
6 changes: 3 additions & 3 deletions content/docs/command-reference/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,9 +209,9 @@ $ dvc run -n second_stage './another_script.sh $MYENVVAR'
- `-m <path>`, `--metrics <path>` - specify a metrics file produced by this
stage. This option behaves like `-o` but registers the file in a `metrics`
field inside the `dvc.yaml` stage. Metrics are usually small, human readable
files (JSON or YAML) with scalar numbers or other simple information that
describes a model (or any other data artifact). See `dvc metrics` to learn
more about _metrics_.
files (JSON, TOML, or YAML) with scalar numbers or other simple information
that describes a model (or any other data artifact). See `dvc metrics` to
learn more about _metrics_.

- `-M <path>`, `--metrics-no-cache <path>` - the same as `-m` except that DVC
does not track the metrics file (same as with `-O` above). This means that
Expand Down
6 changes: 3 additions & 3 deletions content/docs/command-reference/stage/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,9 +204,9 @@ data science experiments.
- `-m <path>`, `--metrics <path>` - specify a metrics file produced by this
stage. This option behaves like `-o` but registers the file in a `metrics`
field inside the `dvc.yaml` stage. Metrics are usually small, human readable
files (JSON or YAML) with scalar numbers or other simple information that
describes a model (or any other data artifact). See `dvc metrics` to learn
more about _metrics_.
files (JSON, TOML, or YAML) with scalar numbers or other simple information
that describes a model (or any other data artifact). See `dvc metrics` to
learn more about _metrics_.

- `-M <path>`, `--metrics-no-cache <path>` - the same as `-m` except that DVC
does not track the metrics file (same as with `-O` above). This means that
Expand Down