From e94e07d26dc270c7a38086a7c69239ecdf1f97f7 Mon Sep 17 00:00:00 2001 From: Puneetha Pai Date: Thu, 23 Jul 2020 12:21:21 +0530 Subject: [PATCH] DVC: add pages for sub commands commit, config, dag --- pages/common/dvc-commit.md | 16 ++++++++++++++++ pages/common/dvc-config.md | 33 +++++++++++++++++++++++++++++++++ pages/common/dvc-dag.md | 20 ++++++++++++++++++++ pages/common/dvc.md | 4 ++-- 4 files changed, 71 insertions(+), 2 deletions(-) create mode 100644 pages/common/dvc-commit.md create mode 100644 pages/common/dvc-config.md create mode 100644 pages/common/dvc-dag.md diff --git a/pages/common/dvc-commit.md b/pages/common/dvc-commit.md new file mode 100644 index 0000000000..47343fd5fb --- /dev/null +++ b/pages/common/dvc-commit.md @@ -0,0 +1,16 @@ +# dvc commit + +> Record changes to DVC-tracked files in the project. +> More information: . + +- Commit latest version, for all DVC-tracked files and directories: + +`dvc commit` + +- Commit latest version, for a given DVC-tracked target: + +`dvc commit {{target}}` + +- Recursively commit all DVC-tracked files in a directory: + +`dvc commit --recursive {{path/to/directory}}` diff --git a/pages/common/dvc-config.md b/pages/common/dvc-config.md new file mode 100644 index 0000000000..6704621515 --- /dev/null +++ b/pages/common/dvc-config.md @@ -0,0 +1,33 @@ +# dvc config + +> Low level command to manage custom configuration options for dvc repositories. +> These configurations can be project/local/global/system level. +> More information: . + +- Get default remote name: + +`dvc config core.remote` + +- Set project default remote: + +`dvc config core.remote {{remote_name}}` + +- Unset project default remote: + +`dvc config --unset core.remote` + +- Get project config value for a key: + +`dvc config key` + +- Set project level config value for a key: + +`dvc config key value` + +- Unset project level config value for a key: + +`dvc config --unset key` + +- Set local/global/system level config: + +`dvc config --local/global/system key value` diff --git a/pages/common/dvc-dag.md b/pages/common/dvc-dag.md new file mode 100644 index 0000000000..af93e46206 --- /dev/null +++ b/pages/common/dvc-dag.md @@ -0,0 +1,20 @@ +# dvc dag + +> Visualize the pipeline(s) in dvc.yaml +> More information: . + +- Visualize entire pipeline: + +`dvc dag` + +- Visualize pipeline stages up to a target stage: + +`dvc dag {{target}}` + +- Export pipeline in dot format: + +`dvc dag --dot > pipeline.dot` + +- Export pipeline as SVG: + +`dvc dag --dot | dot -Tsvg -o pipeline.svg` diff --git a/pages/common/dvc.md b/pages/common/dvc.md index 46f5f996ce..3a49d5d5a0 100644 --- a/pages/common/dvc.md +++ b/pages/common/dvc.md @@ -15,6 +15,6 @@ `dvc {{command}} --help` -- Execute Git command: +- Execute DVC command: -`git {{command}}` +`dvc {{command}}`