Skip to content
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.

Sign up for GitHub

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

Jump to bottom

replace dvc run in cmd-ref #3223

Merged
merged 2 commits into from
Jan 27, 2022
Merged

replace dvc run in cmd-ref #3223

merged 2 commits into from
Jan 27, 2022

Conversation

dberenbaum
Copy link
Contributor

Fix #2997

@shcheklein shcheklein temporarily deployed to dvc-org-dvc-run-depreca-fmpezs January 26, 2022 19:17 Inactive
@dberenbaum dberenbaum mentioned this pull request Jan 26, 2022
Closed
@shcheklein shcheklein requested a review from iesahin January 26, 2022 21:05
iesahin
iesahin suggested changes Jan 27, 2022
View reviewed changes
Copy link
Contributor

@iesahin iesahin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor point in dvc repro. Otherwise looks good to me. Thank you Dave.

content/docs/command-reference/repro.md Outdated
@@ -232,7 +235,7 @@ with open(sys.argv[1], 'r') as f:
print(num_lines)
```

The result of executing these `dvc run` commands should look like this:
The result of executing `dvc repro` should look like this:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The script is about num_lines but the result shows the tree output. I think we need the exact result first, and an explanation for tree in a sentence.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @iesahin! PTAL.

@shcheklein shcheklein temporarily deployed to dvc-org-dvc-run-depreca-fmpezs January 27, 2022 15:16 Inactive
iesahin
iesahin approved these changes Jan 27, 2022
View reviewed changes
Copy link
Contributor

@iesahin iesahin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you Dave, good to go.

@iesahin iesahin merged commit 3c64e92 into master Jan 27, 2022
@iesahin iesahin deleted the dvc-run-deprecate branch January 27, 2022 16:54
@jorgeorpinel
Copy link
Contributor

Thanks a lot @dberenbaum !

jorgeorpinel
jorgeorpinel reviewed Jan 27, 2022
View reviewed changes
Copy link
Contributor

@jorgeorpinel jorgeorpinel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Little post-merge review with possible follow ups for the docs team. 👇

content/docs/command-reference/index.md
Comment on lines 17 to +19
- Process the data with your own source code, using `dvc.yaml` and/or the
`dvc run` command, specifying further <abbr>outputs</abbr> that should also be
tracked by DVC after the code is executed.
`dvc stage add` command to specify further <abbr>outputs</abbr> that should
also be tracked by DVC, and executing the code using `dvc repro`.
Copy link
Contributor

@jorgeorpinel jorgeorpinel Jan 27, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should keep this simpler by not mentioning stage add. It's linked from the dvc.yaml guide anyway, and from what I remember editing that manually is the default recommended way to create stages since DVC 1.x.

content/docs/command-reference/import-url.md
Comment on lines +124 to +125
`dvc import-url` generates an _import `.dvc` file_ and `dvc stage add` a regular
stage (in `dvc.yaml`).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💅 and -> while ?

content/docs/command-reference/params/index.md Show resolved Hide resolved
content/docs/command-reference/plots/modify.md
@@ -134,8 +134,8 @@ plots:

## Example: Template change

_dvc run --plots file.csv ..._ command assign the default template that needs to
be changed in many cases. A simple command changes the template:
_dvc stage add --plots file.csv ..._ command assign the default template that
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should render correctly now:

Suggested change
_dvc stage add --plots file.csv ..._ command assign the default template that
`dvc stage add --plots file.csv ...` assign the default template that

It's just a bit unclear why we're referring to such a specific stage add command at the opening of this example...

content/docs/command-reference/repro.md Show resolved Hide resolved
content/docs/command-reference/status.md
@@ -57,7 +57,7 @@ description_, as detailed below:

- _always changed_ means that this is a `.dvc` file with no dependencies (see
`dvc add`) or that the stage in `dvc.yaml` has the `always_changed: true`
value set (see `--always-changed` option in `dvc run`).
value set (see `--always-changed` option in `dvc stage add`).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually these can now link directly to the option anchor like this 🙂

Suggested change
value set (see `--always-changed` option in `dvc stage add`).
value set (see `dvc stage add --always-changed`).

Per #3140

But we prob. need a separate issue to update these

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extracted to #3236

jorgeorpinel added a commit that referenced this pull request Jan 28, 2022
@jorgeorpinel
ref: rewrite Typical Workflow in index page
ed402c8 
rel. #3223 (comment)
@jorgeorpinel jorgeorpinel mentioned this pull request Jan 28, 2022
Merged
jorgeorpinel added a commit that referenced this pull request Jan 28, 2022
@jorgeorpinel
ref: link "stage" concept to run ref. for now
961a24d 
rel. #3223 (comment)
jorgeorpinel added a commit that referenced this pull request Jan 28, 2022
@jorgeorpinel
ref: stage add --plots autolink from plots modify
02fd71d 
per #3223 (comment)
@jorgeorpinel jorgeorpinel mentioned this pull request Jan 28, 2022
Closed
jorgeorpinel added a commit that referenced this pull request Jan 29, 2022
@jorgeorpinel
ref: misc. improvements around "stage" concept (#3235)
311b554 
* ref: rewrite Typical Workflow in index page
rel. #3223 (comment)

* ref: link "stage" concept to `run` ref. for now
rel. #3223 (comment)

* ref: stage add --plots autolink from plots modify
per #3223 (comment)

* Update content/docs/command-reference/import-url.md

Co-authored-by: Dave Berenbaum <[email protected]>

Co-authored-by: Dave Berenbaum <[email protected]>
iesahin pushed a commit that referenced this pull request Apr 11, 2022
@iesahin
replace dvc run in cmd-ref (#3223)
f704dad
iesahin pushed a commit that referenced this pull request Apr 11, 2022
@jorgeorpinel @iesahin
ref: misc. improvements around "stage" concept (#3235)
d53a1dd 
* ref: rewrite Typical Workflow in index page
rel. #3223 (comment)

* ref: link "stage" concept to `run` ref. for now
rel. #3223 (comment)

* ref: stage add --plots autolink from plots modify
per #3223 (comment)

* Update content/docs/command-reference/import-url.md

Co-authored-by: Dave Berenbaum <[email protected]>

Co-authored-by: Dave Berenbaum <[email protected]>
@dberenbaum dberenbaum mentioned this pull request Jun 9, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jorgeorpinel jorgeorpinel jorgeorpinel left review comments

@iesahin iesahin iesahin approved these changes

Assignees

@dberenbaum dberenbaum

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

ref: replace dvc run examples with dvc stage add + dvc exp run or dvc repro
4 participants
@dberenbaum @jorgeorpinel @iesahin @shcheklein