-
Notifications
You must be signed in to change notification settings - Fork 394
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
cmd ref: consistency updates on
rev
, rev_lock
fields...
and related concepts throughout the docs
- Loading branch information
1 parent
df3781d
commit 89026ce
Showing
5 changed files
with
38 additions
and
29 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,8 +25,7 @@ DVC-file `targets` as command arguments. | |
|
||
Note that import stages are considered always "locked", meaning that if you run | ||
`dvc repro`, they won't be updated. `dvc update` is the only command that can | ||
update them. Also, for `dvc import` import stages, the `rev_lock` field is | ||
updated by `dvc update`. | ||
update them. | ||
|
||
Another detail to note is that when the `--rev` (revision) option of | ||
`dvc import` has been used to create an import stage, DVC is not aware of what | ||
|
@@ -54,10 +53,8 @@ Let's first import a data artifact from our | |
|
||
```dvc | ||
$ dvc import [email protected]:iterative/example-get-started model.pkl | ||
Importing 'model.pkl ([email protected]:iterative/example-get-started)' -> 'model.pkl' | ||
... | ||
Saving information to 'model.pkl.dvc'. | ||
... | ||
Importing 'model.pkl ([email protected]:iterative/example-get-started)' | ||
-> 'model.pkl' | ||
``` | ||
|
||
As DVC mentions, the import stage (DVC-file) `model.pkl.dvc` is created. This | ||
|
@@ -74,3 +71,7 @@ Saving information to 'model.pkl.dvc'. | |
|
||
This time nothing has changed, since the source <abbr>project</abbr> is rather | ||
stable. | ||
|
||
> Note that `dvc update` updates the `rev_lock` field of the corresponding | ||
> [DVC-file](/doc/user-guide/dvc-file-format) (when there are changes to bring | ||
> in). |
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 |
---|---|---|
|
@@ -108,7 +108,7 @@ $ dvc run -d remote://example/data.txt \ | |
``` | ||
|
||
Please refer to `dvc remote add` for more details like setting up access | ||
credentials for certain remotes. | ||
credentials for the different remotes. | ||
|
||
## Example: import-url command | ||
|
||
|
@@ -144,16 +144,16 @@ outs: | |
DVC checks the headers returned by the server, looking for a strong | ||
[ETag](https://en.wikipedia.org/wiki/HTTP_ETag) or a | ||
[Content-MD5](https://tools.ietf.org/html/rfc1864) header, and uses it to know | ||
if the file has changed and we need to download it again. | ||
[Content-MD5](https://tools.ietf.org/html/rfc1864) header, and uses it to | ||
determine whether the source has changed and we need to download the file again. | ||
</details> | ||
## Example: Using import | ||
`dvc import` can download a <abbr>data artifact</abbr> from an external | ||
<abbr>DVC repository</abbr>repository. It also creates an external dependency in | ||
its <abbr>import stage</abbr> (DVC-file). | ||
`dvc import` can download a <abbr>data artifact</abbr> from any <abbr>DVC | ||
repository</abbr>. It also creates an external dependency in its <abbr>import | ||
stage</abbr> (DVC-file). | ||
|
||
```dvc | ||
$ dvc import [email protected]:iterative/example-get-started model.pkl | ||
|
@@ -184,7 +184,7 @@ outs: | |
persist: false | ||
``` | ||
|
||
For external sources that are <abbr>DVC repositories</abbr>, `url` and | ||
`rev_lock` fields are used to specify the origin and version of the dependency. | ||
The `url` and `rev_lock` subfields under `repo` are used to save the origin and | ||
version of the dependency. | ||
|
||
</details> |