Skip to content

Commit

Permalink
woah, silly stuff, move it under description this time
Browse files Browse the repository at this point in the history
  • Loading branch information
Mr. Outis committed Dec 5, 2019
1 parent 93fe5f0 commit e29e498
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions static/docs/command-reference/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,21 @@ captures data and <abbr>caches</abbr> relevant <abbr>data artifacts</abbr> along
the way. See [this example](/doc/get-started/example-pipeline) to learn more and
try creating a pipeline.

### Well-behaved commands

DVC is simple to use, you only need to wrap your commands with `dvc run`, and
define your dependencies and outputs.

However, to prevent unexpected behaviors, ideally, your commands should follow
some principles:

- Read exclusively from specified dependencies.
- Write exclusively to specified outputs.
- Completely rewrite the outputs (do not append).
- Stop reading and writing when the command exits.

This will enhance reproducibility.

## Options

- `-d`, `--deps` - specify a file or a directory the stage depends on. Multiple
Expand Down Expand Up @@ -151,21 +166,6 @@ try creating a pipeline.

- `-v`, `--verbose` - displays detailed tracing information.

### Well-behaved commands

DVC is simple to use, you only need to wrap your commands with `dvc run`, and
define your dependencies and outputs.

However, to prevent unexpected behaviors, ideally, your commands should follow
some principles:

- Read exclusively from specified dependencies.
- Write exclusively to specified outputs.
- Completely rewrite the outputs (do not append).
- Stop reading and writing when the command exits.

This will enhance reproducibility.

## Examples

A trivial example to play with, try different set of options to see how they
Expand Down

0 comments on commit e29e498

Please sign in to comment.