-
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
docs: use --external
for add/run
#1387
Merged
+16
−9
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
54706b6
docs: use `--external` for `add/run`
efiop d57a6d8
Update content/docs/command-reference/add.md
jorgeorpinel 6a8332a
Update content/docs/command-reference/add.md
jorgeorpinel 12a9ff6
term: review usage of "external"
jorgeorpinel 16bb137
Merge branch 'master' into remove_external_local
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 |
---|---|---|
|
@@ -52,8 +52,9 @@ The default local cache location is `.dvc/cache`, so there is no need to specify | |
it explicitly. | ||
|
||
```dvc | ||
$ dvc add /home/shared/mydata | ||
$ dvc add /home/shared/mydata --external | ||
$ dvc run -d data.txt \ | ||
--external \ | ||
-o /home/shared/data.txt \ | ||
cp data.txt /home/shared/data.txt | ||
``` | ||
|
@@ -68,10 +69,11 @@ $ dvc remote add sshcache ssh://[email protected]:/cache | |
$ dvc config cache.ssh sshcache | ||
|
||
# Add data on SSH directly | ||
$ dvc add ssh://[email protected]:/mydata | ||
$ dvc add ssh://[email protected]:/mydata --external | ||
|
||
# Create the stage with external SSH output | ||
$ dvc run -d data.txt \ | ||
--external \ | ||
-o ssh://[email protected]:/home/shared/data.txt \ | ||
scp data.txt [email protected]:/home/shared/data.txt | ||
``` | ||
|
@@ -86,10 +88,11 @@ $ dvc remote add s3cache s3://mybucket/cache | |
$ dvc config cache.s3 s3cache | ||
|
||
# Add data on S3 directly | ||
$ dvc add s3://mybucket/mydata | ||
$ dvc add s3://mybucket/mydata --external | ||
|
||
# Create the stage with external S3 output | ||
$ dvc run -d data.txt \ | ||
--external \ | ||
-o s3://mybucket/data.txt \ | ||
aws s3 cp data.txt s3://mybucket/data.txt | ||
``` | ||
|
@@ -104,10 +107,11 @@ $ dvc remote add gscache gs://mybucket/cache | |
$ dvc config cache.gs gscache | ||
|
||
# Add data on GS directly | ||
$ dvc add gs://mybucket/mydata | ||
$ dvc add gs://mybucket/mydata --external | ||
|
||
# Create the stage with external GS output | ||
$ dvc run -d data.txt \ | ||
--external \ | ||
-o gs://mybucket/data.txt \ | ||
gsutil cp data.txt gs://mybucket/data.txt | ||
``` | ||
|
@@ -122,10 +126,11 @@ $ dvc remote add hdfscache hdfs://[email protected]/cache | |
$ dvc config cache.hdfs hdfscache | ||
|
||
# Add data on HDFS directly | ||
$ dvc add hdfs://[email protected]/mydata | ||
$ dvc add hdfs://[email protected]/mydata --external | ||
|
||
# Create the stage with external HDFS output | ||
$ dvc run -d data.txt \ | ||
--external \ | ||
-o hdfs://[email protected]/home/shared/data.txt \ | ||
hdfs fs -copyFromLocal \ | ||
data.txt \ | ||
|
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.
But external dependencies don't require the use of this flag? Hmmm that may be confusing 😕
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.
Yep, only outs.
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.
Moved to iterative/dvc#1545 (comment) now that this is merged. Thanks