Skip to content

Commit

Permalink
Merge pull request #1131 from iterative/2020-04-08
Browse files Browse the repository at this point in the history
Regular updates (Apr 9)
  • Loading branch information
jorgeorpinel authored Apr 16, 2020
2 parents 7187c8c + 20c17ba commit a9864f0
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 17 deletions.
3 changes: 0 additions & 3 deletions .restyled.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,3 @@ restylers:
- 'pages/**/*.js'
- 'content/**/*.md'
- 'src/**/*.js'
- name: stylelint
include:
- 'src/**/*.css'
4 changes: 2 additions & 2 deletions content/docs/command-reference/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,9 @@ data artifact from the source repo.
default branch) is used by default when this option is not specified.

> Note that this adds a `rev` field in the import stage that fixes it to the
> revision. This can impact the behavior of `dvc update`. (See the
> revision. This can impact the behavior of `dvc update` (see the
> [Importing and updating fixed revisions](#example-importing-and-updating-fixed-revisions)
> example below.)
> example below).
- `-h`, `--help` - prints the usage/help message, and exit.

Expand Down
14 changes: 8 additions & 6 deletions content/docs/command-reference/metrics/diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,15 @@ positional arguments:

## Description

This command means to provide a quick way to compare results from your previous
experiments with the current results of your pipeline, as long as you're using
metrics that DVC is aware of (see `dvc metrics add`).
This command provides a quick way to compare metrics among experiments in the
repository history. Requires that Git is being used to version the project
metrics.

Run without arguments, this command compares all existing metric files currently
present in the <abbr>workspace</abbr> (including uncommitted changes) with the
latest committed version.
> Metrics can be defined with `dvc metrics add`, ot the `-m` and `-M` options of
> `dvc run`.
Run without arguments, this command compares metrics currently present in the
<abbr>workspace</abbr> uncommitted changes) with the latest committed version.

The differences shown by this command include the new value, and numeric
difference (delta) from the previous value of metrics (with 3-digit accuracy).
Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/metrics/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ COMMAND

In order to track metrics associated to machine learning experiments, DVC has
the ability to mark a certain stage <abbr>outputs</abbr> as files containing
metrics to track. (See the `--metrics` option of `dvc run`.) Metrics are
metrics to track (see the `--metrics` option of `dvc run`). Metrics are
project-specific floating-point values e.g. `AUC`, `ROC`, etc.

Supported file formats: JSON. Metrics can be organized in a tree hierarchy in a
Expand Down
4 changes: 2 additions & 2 deletions content/docs/command-reference/metrics/modify.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ positional arguments:

This command finds a corresponding [DVC-file](/doc/user-guide/dvc-file-format)
for the provided metric file (`path` is defined among the <abbr>outputs</abbr>
of the DVC-file), and updates the default formatting of the metric. (See the
[options](#options) below and `dvc metrics show` for more info.)
of the DVC-file), and updates the default formatting of the metric. See the
[options](#options) below and `dvc metrics show` for more info.

If `path` isn't tracked by DVC (described in one of the <abbr>workspace</abbr>
DVC-files), the following error will be raised:
Expand Down
9 changes: 7 additions & 2 deletions content/docs/command-reference/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ usage: dvc run [-h] [-q | -v] [-d <path>] [-o <path>] [-O <path>]
[-p <params>] [-m <path>] [-M <path>] [-f <filename>]
[-w <path>] [--no-exec] [-y] [--overwrite-dvcfile]
[--ignore-build-cache] [--no-commit]
[--outs-persist OUTS_PERSIST]
[--outs-persist-no-cache OUTS_PERSIST_NO_CACHE]
[--outs-persist <path>] [--outs-persist-no-cache <path>]
[--always-changed]
command
Expand Down Expand Up @@ -120,6 +119,12 @@ data pipeline (e.g. random numbers, time functions, hardware dependency, etc.)
enough to be tracked by Git directly, or if these files are not of future
interest.

- `--outs-persist <path>` - declare output file or directory that will not be
removed upon `dvc repro`.

- `--outs-persist-no-cache <path>` - the same as `-outs-persist` except that
outputs are not tracked by DVC.

- `-m <path>`, `--metrics <path>` - specify a metric type of output. This option
behaves like `-o` but also adds `metric: true` in the output record of the
resulting stage file. Metrics are usually small, human readable files (e.g.
Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/version.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ The detail of `Binary` depends on the way DVC was downloaded and
systems) - source code is stored as Python package

This method of installation involves downloading DVC source code, and
following certain setup instructions (See the
following certain setup instructions (see the
[development](/doc/install/pre-release) guide) to build the application before
being able to it.

Expand Down

0 comments on commit a9864f0

Please sign in to comment.