-
Notifications
You must be signed in to change notification settings - Fork 394
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
ref: misc. improvements around "stage" concept #3235
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
ed402c8
ref: rewrite Typical Workflow in index page
jorgeorpinel 961a24d
ref: link "stage" concept to `run` ref. for now
jorgeorpinel 02fd71d
ref: stage add --plots autolink from plots modify
jorgeorpinel b119600
Update content/docs/command-reference/import-url.md
jorgeorpinel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,16 +10,14 @@ does not change directories in your terminal). | |
|
||
## Typical DVC workflow | ||
|
||
- In an existing Git repository, initialize a <abbr>DVC project</abbr> with | ||
`dvc init`. | ||
- Copy data files or dataset directories for modeling into the repository, and | ||
track them with DVC using the `dvc add` command. | ||
- Process the data with your own source code, using `dvc.yaml` and/or the | ||
`dvc stage add` command to specify further <abbr>outputs</abbr> that should | ||
Comment on lines
11
to
-18
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ended up rewriting this whole section 😅 |
||
also be tracked by DVC, and executing the code using `dvc repro`. | ||
- Sharing a <abbr>DVC repository</abbr> with the codified data | ||
[pipeline](/doc/command-reference/dag) will not include the project's | ||
<abbr>cache</abbr>. Use [remote storage](/doc/command-reference/remote) and | ||
`dvc push` to share this cache (data tracked by DVC). | ||
- Use `dvc repro` to automatically reproduce your full pipeline iteratively as | ||
input data or source code change. | ||
- Initialize a <abbr>DVC project</abbr> in a Git repo with `dvc init`. | ||
- Copy data files or dataset directories for modeling into the project and use | ||
`dvc add` to tell DVC to <abbr>cache</abbr> and track them. | ||
- Create a simple `dvc.yaml` file to codify a data processing | ||
[pipeline](/doc/command-reference/dag). It uses your own source code and | ||
specifies further data <abbr>outputs</abbr> for DVC to control. | ||
- Execute or restore any version of your pipeline using `dvc repro`, or | ||
experiment on it with `dvc exp` features. | ||
- Sharing the <abbr>repository</abbr> will not include locally cached data. Use | ||
[remote storage](/doc/command-reference/remote) with `dvc push` and `dvc pull` | ||
to share data artifacts. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -134,8 +134,8 @@ plots: | |
|
||
## Example: Template change | ||
|
||
_dvc stage add --plots file.csv ..._ command assign the default template that | ||
needs to be changed in many cases. A simple command changes the template: | ||
Something like `dvc stage add --plots file.csv ...` assigns the default | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We can auto-link to https://dvc.org/doc/command-reference/stage/add#--plots directly from here now. |
||
template, which needs to be changed in many cases. This command can do so: | ||
|
||
```dvc | ||
$ dvc plots modify classes.csv --template confusion | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These are for consistency (only place where
stage
ref is linked insted ofrun
) for now. Wil be properly addressed in #2883.