Commit cmdref updates per 1.x #1626
Conversation
| deleted: model.pkl | ||
| deleted: data/features/test.pkl | ||
| deleted: data/features/train.pkl | ||
| deleted: data/data.xml |
There was a problem hiding this comment.
@jorgeorpinel When I replicated this example it didn't show data/data.xml.
There was a problem hiding this comment.
@imhardikj the changes look good but it's a little strange that you would focus only on updating the examples in 2 command references, instead of the entire ref. even if it's just one command at a time... Can you please finish updating the entire ref of any one of these, and leave the other one for another PR? Thanks
There are conflicting files in the PR. Please merge master into your branch. |
| Record changes to DVC-tracked files in the <abbr>project</abbr>, by updating | ||
| [DVC-files](/doc/user-guide/dvc-files-and-directories) and saving | ||
| Record changes to DVC-tracked files in the <abbr>project</abbr>, by updating the | ||
| [stages](/doc/command-reference/run) (or `.dvc` files) and saving |
There was a problem hiding this comment.
It doesn't change stages, can you check what it does and try again? 🙂
And no need for parenthesis around "and .dvc files".
There was a problem hiding this comment.
I think commit only saves data to cache, it doesn't update dvc.lock or .dvc files. But the previous definition had the updating part so I didn't change it.
There was a problem hiding this comment.
Hey sorry, I was out a few days. I'm back, let me review this again.
There was a problem hiding this comment.
Continued this conversation in #1626 (review).
| just use `dvc commit` to force update the related DVC-files and cache. | ||
| just use `dvc commit` to force update the related stage (or `.dvc` file) and | ||
| cache. |
There was a problem hiding this comment.
Changed this to save updated DVC-tracked files to the cache.
There was a problem hiding this comment.
Same. Continued in #1626 (review)
| <abbr>cache</abbr> after creating a DVC-file. What _commit_ means is that DVC: | ||
| <abbr>cache</abbr> after creating or updating the `dvc.yaml` (or `.dvc` file). | ||
| What _commit_ means is that DVC: |
There was a problem hiding this comment.
OK, this is closer but still not quite right. Is dvc.yaml the relevant special file to mention?
There was a problem hiding this comment.
Actually dvc.lock and .dvc will be updated if we run repro after doing changes in some files(deps).
And dvc.yaml will be updated in case we run a stage for first time.
There was a problem hiding this comment.
Here I think instead of mentioning all three(which I did currently), it can be updating the stage or .dvc file😅
There was a problem hiding this comment.
"updating the stage" would be incorrect. Again, commit does not change the stage at all. A stage = a command, its dependencies (paths), and outputs (paths).
There was a problem hiding this comment.
Continued in #1626 (review).
| manually editing or generating DVC <abbr>outputs</abbr>; or to force the | ||
| `dvc.lock` or `.dvc` updates without reproducing stages or pipelines. These |
There was a problem hiding this comment.
Not sure about the grammar here. "the .dvc updates"? Please review the phrase between force...updates here.
| force-update the [DVC-files](/doc/user-guide/dvc-files-and-directories) and save | ||
| data to cache. They are still useful, but keep in mind that DVC can't guarantee | ||
| reproducibility in those cases. | ||
| force-update the `dvc.lock` or `.dvc` files and save data to cache. They are |
There was a problem hiding this comment.
Perfect 🙏
It was just a simple replacement of "DVC-file" -> "dvc.lock or/and .dvc files" in most places but I wanted you to figure it out 🙂
| - `-d`, `--with-deps` - determines files to commit by tracking dependencies to | ||
| the target DVC-files (stages). If no `targets` are provided, this option is | ||
| ignored. By traversing all stage dependencies, DVC searches backward from the | ||
| target stages in the corresponding pipelines. This means DVC will not commit | ||
| files referenced in later stages than the `targets`. | ||
| the target stages or `.dvc` files. If no `targets` are provided, this option | ||
| is ignored. By traversing all stage dependencies, DVC searches backward from | ||
| the target stages in the corresponding pipelines. This means DVC will not | ||
| commit files referenced in later stages than the `targets`. |
There was a problem hiding this comment.
OK for now but
- We need to update this option desc. in several cmd refs.
(out of scope for this PR)
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
There was a problem hiding this comment.
The file tracked by .dvc is its dependency. So the text is correct.
There was a problem hiding this comment.
That part is correct but there's no mention of dvc.yaml and the text could probably be simplified a little. It's OK for now.
| - `-R`, `--recursive` - determines the files to commit by searching each target | ||
| directory and its subdirectories for DVC-files to inspect. If there are no | ||
| directories among the `targets`, this option is ignored. | ||
| directory and its subdirectories for stages or `.dvc` files to inspect. If | ||
| there are no directories among the `targets`, this option is ignored. |
There was a problem hiding this comment.
- Should probably use
stages (in `dvc.yaml`) or `.dvc` files
But let's leave it for another PR since this option is also in several refs.
| manually editing or generating DVC <abbr>outputs</abbr>; or to force the | ||
| `dvc.lock` or the `.dvc` updates without reproducing stages or pipelines. These |
There was a problem hiding this comment.
Still weird grammar 😢
There was a problem hiding this comment.
Adding "the" everywhere is not a solution for all grammar issues 😄 need to read it and see if there are missing words, etc... 🙏
This comment has been minimized.
This comment has been minimized.
Partially addresses some of the tasks from #1255
dvc.yamlThis PR updates
commitcmd ref.Pending after this PR:
#1626 (review) and
#1626 (review)