From c63f52584e436dff4f69d61f89b55eb157d288bd Mon Sep 17 00:00:00 2001 From: Emre Sahin Date: Sun, 4 Aug 2024 17:45:22 +0300 Subject: [PATCH] Update ref docs showing pipeline outputs --- CHANGELOG.md | 2 +- book/src/ref/xvc-pipeline-run.md | 4 ++-- book/src/ref/xvc-pipeline-step-dependency-file.md | 6 +++--- book/src/ref/xvc-pipeline-step-dependency-generic.md | 6 +++--- book/src/ref/xvc-pipeline-step-dependency-glob-items.md | 6 +++--- book/src/ref/xvc-pipeline-step-dependency-glob.md | 4 ++-- book/src/ref/xvc-pipeline-step-dependency-line-items.md | 4 ++-- book/src/ref/xvc-pipeline-step-dependency-lines.md | 4 ++-- book/src/ref/xvc-pipeline-step-dependency-param.md | 6 +++--- book/src/ref/xvc-pipeline-step-dependency-regex-items.md | 6 +++--- book/src/ref/xvc-pipeline-step-dependency-regex.md | 4 ++-- book/src/ref/xvc-pipeline-step-dependency-sqlite-query.md | 6 +++--- book/src/ref/xvc-pipeline-step-dependency-step.md | 6 +++--- book/src/ref/xvc-pipeline-step-dependency-url.md | 2 +- book/src/ref/xvc-pipeline-step-dependency.md | 4 +++- 15 files changed, 36 insertions(+), 34 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 731fe849c..8b741b579 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,7 +8,7 @@ tree, and subtasks are marked with indentation. - Removed caching for globs that caused bugs in Python bindings. - Documentation updates - Fix optional features. Now inter-workspace dependencies are defined by `default-features = false` on Cargo.toml -- Added `bundled-openssl` feature to use `vendored` feature of `openssl` crate optionally. This is turned on for Windows. +- Added `bundled-openssl` feature to use `vendored` feature of `openssl` crate optionally. This is turned on for Windows builds on GA. ## 0.6.9 (2024-07-29) diff --git a/book/src/ref/xvc-pipeline-run.md b/book/src/ref/xvc-pipeline-run.md index 0e6e46adf..6671792d4 100644 --- a/book/src/ref/xvc-pipeline-run.md +++ b/book/src/ref/xvc-pipeline-run.md @@ -56,7 +56,7 @@ You can run the default pipeline without specifying its name. $ xvc pipeline run [OUT] [hello] hello -[DONE] hello (echo hello) +[DONE] [hello] (echo hello) ``` @@ -85,7 +85,7 @@ $ xvc pipeline --pipeline-name my-pipeline step new --step-name my-hello --comma $ xvc pipeline run --pipeline-name my-pipeline [OUT] [my-hello] hello from my-pipeline -[DONE] my-hello (echo 'hello from my-pipeline') +[DONE] [my-hello] (echo 'hello from my-pipeline') ``` diff --git a/book/src/ref/xvc-pipeline-step-dependency-file.md b/book/src/ref/xvc-pipeline-step-dependency-file.md index 2617e4868..947af167f 100644 --- a/book/src/ref/xvc-pipeline-step-dependency-file.md +++ b/book/src/ref/xvc-pipeline-step-dependency-file.md @@ -27,7 +27,7 @@ When you run the command, it will print `data.txt has changed` if the file `data $ xvc pipeline run [OUT] [file-dependency] data.txt has changed -[DONE] file-dependency (echo data.txt has changed) +[DONE] [file-dependency] (echo data.txt has changed) ``` @@ -45,7 +45,7 @@ A step will run if any of its dependencies have changed. $ xvc pipeline run [OUT] [file-dependency] data.txt has changed -[DONE] file-dependency (echo data.txt has changed) +[DONE] [file-dependency] (echo data.txt has changed) ``` @@ -69,7 +69,7 @@ Now the step will run even if none of the dependencies have changed. $ xvc pipeline run [OUT] [file-dependency] data.txt has changed -[DONE] file-dependency (echo data.txt has changed) +[DONE] [file-dependency] (echo data.txt has changed) ``` diff --git a/book/src/ref/xvc-pipeline-step-dependency-generic.md b/book/src/ref/xvc-pipeline-step-dependency-generic.md index 3dfaa0c02..44689a574 100644 --- a/book/src/ref/xvc-pipeline-step-dependency-generic.md +++ b/book/src/ref/xvc-pipeline-step-dependency-generic.md @@ -36,7 +36,7 @@ The step won't run until tomorrow, when `date +%F` changes. $ xvc pipeline run [OUT] [morning-message] Good Morning! -[DONE] morning-message (echo 'Good Morning!') +[DONE] [morning-message] (echo 'Good Morning!') ``` @@ -52,7 +52,7 @@ $ xvc pipeline step dependency --step-name directory-contents --generic 'ls' $ xvc pipeline run [OUT] [directory-contents] Files changed -[DONE] directory-contents (echo 'Files changed') +[DONE] [directory-contents] (echo 'Files changed') ``` @@ -66,7 +66,7 @@ $ xvc-test-helper generate-random-file new-file.txt $ xvc pipeline run [OUT] [directory-contents] Files changed -[DONE] directory-contents (echo 'Files changed') +[DONE] [directory-contents] (echo 'Files changed') ``` diff --git a/book/src/ref/xvc-pipeline-step-dependency-glob-items.md b/book/src/ref/xvc-pipeline-step-dependency-glob-items.md index 7abb83cde..7e0a3cdca 100644 --- a/book/src/ref/xvc-pipeline-step-dependency-glob-items.md +++ b/book/src/ref/xvc-pipeline-step-dependency-glob-items.md @@ -63,7 +63,7 @@ dir-0002/file-0003.bin ### Changed Files: -[DONE] files-changed (echo "### Added Files:/n${XVC_ADDED_GLOB_ITEMS}/n### Removed Files:/n${XVC_REMOVED_GLOB_ITEMS}/n### Changed Files:/n${XVC_CHANGED_GLOB_ITEMS}") +[DONE] [files-changed] (echo "### Added Files:/n${XVC_ADDED_GLOB_ITEMS}/n### Removed Files:/n${XVC_REMOVED_GLOB_ITEMS}/n### Changed Files:/n${XVC_CHANGED_GLOB_ITEMS}") $ xvc pipeline run @@ -83,7 +83,7 @@ dir-0001/file-0001.bin ### Changed Files: -[DONE] files-changed (echo "### Added Files:/n${XVC_ADDED_GLOB_ITEMS}/n### Removed Files:/n${XVC_REMOVED_GLOB_ITEMS}/n### Changed Files:/n${XVC_CHANGED_GLOB_ITEMS}") +[DONE] [files-changed] (echo "### Added Files:/n${XVC_ADDED_GLOB_ITEMS}/n### Removed Files:/n${XVC_REMOVED_GLOB_ITEMS}/n### Changed Files:/n${XVC_CHANGED_GLOB_ITEMS}") ``` @@ -101,7 +101,7 @@ $ xvc pipeline run ### Changed Files: dir-0001/file-0002.bin -[DONE] files-changed (echo "### Added Files:/n${XVC_ADDED_GLOB_ITEMS}/n### Removed Files:/n${XVC_REMOVED_GLOB_ITEMS}/n### Changed Files:/n${XVC_CHANGED_GLOB_ITEMS}") +[DONE] [files-changed] (echo "### Added Files:/n${XVC_ADDED_GLOB_ITEMS}/n### Removed Files:/n${XVC_REMOVED_GLOB_ITEMS}/n### Changed Files:/n${XVC_CHANGED_GLOB_ITEMS}") ``` diff --git a/book/src/ref/xvc-pipeline-step-dependency-glob.md b/book/src/ref/xvc-pipeline-step-dependency-glob.md index 9a3b101aa..e3d2103aa 100644 --- a/book/src/ref/xvc-pipeline-step-dependency-glob.md +++ b/book/src/ref/xvc-pipeline-step-dependency-glob.md @@ -48,7 +48,7 @@ The step is invalidated when a file described by the glob is added, removed or c $ xvc pipeline run [OUT] [files-changed] Files have changed. -[DONE] files-changed (echo 'Files have changed.') +[DONE] [files-changed] (echo 'Files have changed.') $ xvc pipeline run @@ -62,7 +62,7 @@ $ rm dir-0001/file-0001.bin $ xvc pipeline run [OUT] [files-changed] Files have changed. -[DONE] files-changed (echo 'Files have changed.') +[DONE] [files-changed] (echo 'Files have changed.') ``` diff --git a/book/src/ref/xvc-pipeline-step-dependency-line-items.md b/book/src/ref/xvc-pipeline-step-dependency-line-items.md index daab4b15e..7311478aa 100644 --- a/book/src/ref/xvc-pipeline-step-dependency-line-items.md +++ b/book/src/ref/xvc-pipeline-step-dependency-line-items.md @@ -77,7 +77,7 @@ $ xvc pipeline run Removed Lines: -[DONE] print-top-10 (echo "Added Lines:/n ${XVC_ADDED_LINE_ITEMS}/nRemoved Lines:/n${XVC_REMOVED_LINE_ITEMS}") +[DONE] [print-top-10] (echo "Added Lines:/n ${XVC_ADDED_LINE_ITEMS}/nRemoved Lines:/n${XVC_REMOVED_LINE_ITEMS}") ``` @@ -105,7 +105,7 @@ $ xvc pipeline run Removed Lines: "Hank", "M", 30, 71, 158 -[DONE] print-top-10 (echo "Added Lines:/n ${XVC_ADDED_LINE_ITEMS}/nRemoved Lines:/n${XVC_REMOVED_LINE_ITEMS}") +[DONE] [print-top-10] (echo "Added Lines:/n ${XVC_ADDED_LINE_ITEMS}/nRemoved Lines:/n${XVC_REMOVED_LINE_ITEMS}") ``` diff --git a/book/src/ref/xvc-pipeline-step-dependency-lines.md b/book/src/ref/xvc-pipeline-step-dependency-lines.md index 951d571bf..a947f2acd 100644 --- a/book/src/ref/xvc-pipeline-step-dependency-lines.md +++ b/book/src/ref/xvc-pipeline-step-dependency-lines.md @@ -67,7 +67,7 @@ $ xvc pipeline run "Hank", "M", 30, 71, 158 "Ivan", "M", 53, 72, 175 -[DONE] print-top-10 (head people.csv) +[DONE] [print-top-10] (head people.csv) `````` @@ -101,7 +101,7 @@ $ xvc pipeline run "Ferzan", "M", 30, 71, 158 "Ivan", "M", 53, 72, 175 -[DONE] print-top-10 (head people.csv) +[DONE] [print-top-10] (head people.csv) ``` diff --git a/book/src/ref/xvc-pipeline-step-dependency-param.md b/book/src/ref/xvc-pipeline-step-dependency-param.md index bb7f1a65f..fbcb75200 100644 --- a/book/src/ref/xvc-pipeline-step-dependency-param.md +++ b/book/src/ref/xvc-pipeline-step-dependency-param.md @@ -50,11 +50,11 @@ Run for the first time, as initially all dependencies are invalid: $ xvc pipeline run [OUT] [read-hyperparams] Update Hyperparameters -[DONE] read-hyperparams (echo "Update Hyperparameters") +[DONE] [read-hyperparams] (echo "Update Hyperparameters") [OUT] [read-database-config] Updated Database Configuration -[DONE] read-database-config (echo "Updated Database Configuration") +[DONE] [read-database-config] (echo "Updated Database Configuration") ``` @@ -77,7 +77,7 @@ $ perl -pi -e 's/5432/9876/g' myparams.yaml $ xvc pipeline run [OUT] [read-database-config] Updated Database Configuration -[DONE] read-database-config (echo "Updated Database Configuration") +[DONE] [read-database-config] (echo "Updated Database Configuration") ``` diff --git a/book/src/ref/xvc-pipeline-step-dependency-regex-items.md b/book/src/ref/xvc-pipeline-step-dependency-regex-items.md index 2b0dd1a6c..90a6a9fbc 100644 --- a/book/src/ref/xvc-pipeline-step-dependency-regex-items.md +++ b/book/src/ref/xvc-pipeline-step-dependency-regex-items.md @@ -77,7 +77,7 @@ $ xvc pipeline run "Omar", "M", 38, 70, 145 "Quin", "M", 29, 71, 176 -[DONE] new-males (echo "New Males:/n ${XVC_ADDED_REGEX_ITEMS}") +[DONE] [new-males] (echo "New Males:/n ${XVC_ADDED_REGEX_ITEMS}") [OUT] [new-females] New Females: "Elly", "F", 30, 66, 124 @@ -88,7 +88,7 @@ $ xvc pipeline run "Page", "F", 31, 67, 135 "Ruth", "F", 28, 65, 131 -[DONE] new-females (echo "New Females:/n ${XVC_ADDED_REGEX_ITEMS}") +[DONE] [new-females] (echo "New Females:/n ${XVC_ADDED_REGEX_ITEMS}") ``` @@ -132,7 +132,7 @@ $ xvc pipeline run [OUT] [new-females] New Females: "Asude", "F", 12, 55, 110 -[DONE] new-females (echo "New Females:/n ${XVC_ADDED_REGEX_ITEMS}") +[DONE] [new-females] (echo "New Females:/n ${XVC_ADDED_REGEX_ITEMS}") ``` diff --git a/book/src/ref/xvc-pipeline-step-dependency-regex.md b/book/src/ref/xvc-pipeline-step-dependency-regex.md index ac63d4563..3bff6b7a0 100644 --- a/book/src/ref/xvc-pipeline-step-dependency-regex.md +++ b/book/src/ref/xvc-pipeline-step-dependency-regex.md @@ -57,7 +57,7 @@ When you run the pipeline initially, the steps are run. $ xvc pipeline run [OUT] [count-females] 7 -[DONE] count-females (grep -c '"F",' people.csv) +[DONE] [count-females] (grep -c '"F",' people.csv) `````` @@ -100,7 +100,7 @@ $ cat people.csv $ xvc pipeline run [OUT] [count-females] 8 -[DONE] count-females (grep -c '"F",' people.csv) +[DONE] [count-females] (grep -c '"F",' people.csv) ``` diff --git a/book/src/ref/xvc-pipeline-step-dependency-sqlite-query.md b/book/src/ref/xvc-pipeline-step-dependency-sqlite-query.md index 4df59fbd8..9d7d7894d 100644 --- a/book/src/ref/xvc-pipeline-step-dependency-sqlite-query.md +++ b/book/src/ref/xvc-pipeline-step-dependency-sqlite-query.md @@ -61,7 +61,7 @@ Let's run the step without a dependency first. $ xvc pipeline run [OUT] [average-age] 34.6666666666667 -[DONE] average-age (sqlite3 people.db 'SELECT AVG(Age) FROM People;') +[DONE] [average-age] (sqlite3 people.db 'SELECT AVG(Age) FROM People;') ``` @@ -83,7 +83,7 @@ So, when the number of people in the table changes, the step will run. Initially $ xvc pipeline run [OUT] [average-age] 34.6666666666667 -[DONE] average-age (sqlite3 people.db 'SELECT AVG(Age) FROM People;') +[DONE] [average-age] (sqlite3 people.db 'SELECT AVG(Age) FROM People;') ``` @@ -107,7 +107,7 @@ This time, the step will run again as the result from dependency query (`SELECT $ xvc pipeline run [OUT] [average-age] 33.3684210526316 -[DONE] average-age (sqlite3 people.db 'SELECT AVG(Age) FROM People;') +[DONE] [average-age] (sqlite3 people.db 'SELECT AVG(Age) FROM People;') ``` diff --git a/book/src/ref/xvc-pipeline-step-dependency-step.md b/book/src/ref/xvc-pipeline-step-dependency-step.md index 8f7493c87..4d01a33d5 100644 --- a/book/src/ref/xvc-pipeline-step-dependency-step.md +++ b/book/src/ref/xvc-pipeline-step-dependency-step.md @@ -25,11 +25,11 @@ When run, the dependency will be run first and the step will be run after. $ xvc pipeline run [OUT] [hello] hello -[DONE] hello (echo hello) +[DONE] [hello] (echo hello) [OUT] [world] world -[DONE] world (echo world) +[DONE] [world] (echo world) ``` @@ -49,7 +49,7 @@ $ xvc pipeline step update --step-name world --when always $ xvc pipeline run [OUT] [world] world -[DONE] world (echo world) +[DONE] [world] (echo world) ``` diff --git a/book/src/ref/xvc-pipeline-step-dependency-url.md b/book/src/ref/xvc-pipeline-step-dependency-url.md index da120083b..4df471bf2 100644 --- a/book/src/ref/xvc-pipeline-step-dependency-url.md +++ b/book/src/ref/xvc-pipeline-step-dependency-url.md @@ -26,7 +26,7 @@ The step is invalidated when the page is updated. $ xvc pipeline run [OUT] [xvc-docs-update] Xvc docs updated! -[DONE] xvc-docs-update (echo 'Xvc docs updated!') +[DONE] [xvc-docs-update] (echo 'Xvc docs updated!') ``` diff --git a/book/src/ref/xvc-pipeline-step-dependency.md b/book/src/ref/xvc-pipeline-step-dependency.md index 83f5df1b9..804678211 100644 --- a/book/src/ref/xvc-pipeline-step-dependency.md +++ b/book/src/ref/xvc-pipeline-step-dependency.md @@ -43,7 +43,9 @@ Options: The difference between this and the glob-items option is that the glob-items option keeps track of all matching files individually, but this option only keeps track of the matched files' digest. This dependency uses considerably less disk space. --param - Add a parameter dependency to the step in the form filename.yaml::model.units . Can be used multiple times + Add a parameter dependency to the step in the form filename.yaml::model.units + + The file can be a JSON, TOML, or YAML file. You can specify hierarchical keys like my.dict.key --regex_items Add a regex dependency in the form filename.txt:/^regex/ . Can be used multiple times.