diff --git a/static/docs/commands-reference/add.md b/static/docs/commands-reference/add.md index 2fd29b21d2..b5e78342bd 100644 --- a/static/docs/commands-reference/add.md +++ b/static/docs/commands-reference/add.md @@ -10,7 +10,7 @@ usage: dvc add [-h] [-q | -v] [-R] [--no-commit] [-f FILE] targets [targets ...] positional arguments: - targets Input files/directories. + targets Input files/directories to add. ``` ## Description @@ -78,10 +78,11 @@ This way you bring data provenance and make your project reproducible. ## Options -- `-R`, `--recursive` - `targets` is expected to contain directory path(s). - Determines the files to add by searching each target directory and its - subdirectories for data files. For each file found, a new DVC-file is created - using the process described in this command's description. +- `-R`, `--recursive` - `targets` is expected to contain at least one directory + path for this option to have effect. Determines the files to add by searching + each target directory and its subdirectories for data files. For each file + found, a new DVC-file is created using the process described in this command's + description. - `--no-commit` - do not put files/directories into cache. A DVC-file is created, and an entry is added to `.dvc/state`, while nothing is added to the diff --git a/static/docs/commands-reference/checkout.md b/static/docs/commands-reference/checkout.md index e88468b78d..ef73a0b025 100644 --- a/static/docs/commands-reference/checkout.md +++ b/static/docs/commands-reference/checkout.md @@ -9,7 +9,8 @@ usage: dvc checkout [-h] [-q | -v] [-d] [-f] [-R] [targets [targets ...]] positional arguments: - targets DVC files. + targets DVC-files to checkout. Optional. (Finds all + DVC-files in the workspace by default.) ``` ## Description @@ -80,10 +81,13 @@ be pulled from a remote cache using `dvc pull`. backward from the target stage(s) in the corresponding pipeline(s). This means DVC will not checkout files referenced in later stage(s) than `targets`. -- `-R`, `--recursive` - performs recursive checkout for target directory. +- `-R`, `--recursive` - `targets` is expected to contain at least one directory + path for this option to have effect. Determines the files to checout by + searching each target directory and its subdirectories for DVC-files to + inspect. - `-f`, `--force` - does not prompt when removing workspace files. Changing the - current set of DVC files with SCM commands like `git checkout` can result in + current set of DVC-files with SCM commands like `git checkout` can result in the need for DVC to remove files which should not exist in the current state and are missing in the local cache (they are not committed in DVC terms). This option controls whether the user will be asked to confirm these files removal. diff --git a/static/docs/commands-reference/commit.md b/static/docs/commands-reference/commit.md index d4ba085e45..925719f064 100644 --- a/static/docs/commands-reference/commit.md +++ b/static/docs/commands-reference/commit.md @@ -1,7 +1,7 @@ # commit -Record changes to the repository by updating DVC-files and saving outputs to -cache. +Record changes to the repository by updating +[DVC-files](/doc/user-guide/dvc-file-format) and saving outputs to cache. ## Synopsis @@ -10,7 +10,8 @@ usage: dvc commit [-h] [-q | -v] [-f] [-d] [-R] [targets [targets ...]] positional arguments: - targets DVC files. + targets DVC-files to commit. Optional. (Finds all + DVC-files in the workspace by default.) ``` ## Description @@ -69,11 +70,10 @@ It handles that last step of adding the file to the DVC cache. backward from the target stage(s) in the corresponding pipeline(s). This means DVC will not commit files referenced in later stage(s) than `targets`. -- `-R`, `--recursive` - `targets` is expected to contain directory path(s). - Determines the files to commit by searching each target directory and its - subdirectories for DVC-files to inspect. Along with providing `targets`, or - `targets` and `--with-deps`, this is another way to limit the scope of - DVC-files to commit. +- `-R`, `--recursive` - `targets` is expected to contain at least one directory + path for this option to have effect. Determines the files to commit by + searching each target directory and its subdirectories for DVC-files to + inspect. - `-f`, `--force` - commit data even if checksums for dependencies or outputs did not change. diff --git a/static/docs/commands-reference/fetch.md b/static/docs/commands-reference/fetch.md index 00e214c8e3..bc957e60fa 100644 --- a/static/docs/commands-reference/fetch.md +++ b/static/docs/commands-reference/fetch.md @@ -12,7 +12,8 @@ usage: dvc fetch [-h] [-q | -v] [-j JOBS] [--show-checksums] [targets [targets ...]] positional arguments: - targets DVC files. + targets Limit command scope to these DVC-files. Using -R, + directories to search DVC-files in can also be given. ``` ## Description @@ -22,7 +23,7 @@ the local cache, but not directly into the workspace. This makes the data files available for linking (or copying) into the workspace. (Refer to [dvc config cache.type](/doc/commands-reference/config#cache).) Along with `dvc checkout`, it's performed automatically by `dvc pull` when the target -DVC-files are not already in the local cache: +[DVC-files](/doc/user-guide/dvc-file-format) are not already in the local cache: ``` Controlled files Commands @@ -83,9 +84,10 @@ specified in DVC-files currently in the workspace are considered by `dvc fetch` backward from the target stage(s) in the corresponding pipeline(s). This means DVC will not fetch files referenced in later stage(s) than `targets`. -- `-R`, `--recursive` - this option tells DVC that `targets` are directories - (not DVC-files), and to traverse them recursively. All DVC-files found will be - read in order to determine the set of data files to fetch. +- `-R`, `--recursive` - `targets` is expected to contain at least one directory + path for this option to have effect. Determines the files to fetch by + searching each target directory and its subdirectories for DVC-files to + inspect. - `-j JOBS`, `--jobs JOBS` - number of threads to run simultaneously to handle the downloading of files from the remote. Using more jobs may improve the diff --git a/static/docs/commands-reference/lock.md b/static/docs/commands-reference/lock.md index 0ae0848a83..da49ec356a 100644 --- a/static/docs/commands-reference/lock.md +++ b/static/docs/commands-reference/lock.md @@ -13,7 +13,7 @@ if `--force` is provided. usage: dvc lock [-h] [-q | -v] targets [targets ...] positional arguments: - targets DVC-files. + targets DVC-files to lock. ``` ## Description diff --git a/static/docs/commands-reference/metrics_show.md b/static/docs/commands-reference/metrics_show.md index 6f88a1e325..5e77913891 100644 --- a/static/docs/commands-reference/metrics_show.md +++ b/static/docs/commands-reference/metrics_show.md @@ -18,14 +18,15 @@ It will find and print all metric files (default) or a specified metric file in the current branch (if `path` is provided) or across all branches/tags (if `-a` or`-T` specified respectively). -Optional `path` should be path to a directory (if `-R` options specified) or a -regular metric file. If `path` is a directory, recursively search and process -all metric files in path. +The optional `path` argument can represent a DVC metric file or a directory. If +`path` is a directory, recursively search and process all metric files in it +with the `-R` option. -If metric type is specified (via `-t`) it overrides the type and xpath defined -(if any) in the corresponding DVC-file (usually, using `dvc metrics modify` -command). If `-t` is not specified `-x` is ignored. The type can be detected by -the file extension automatically if the type is supported. +If metric type is specified (via `-t`) it overrides the type and `--xpath` +defined (if any) in the corresponding DVC-file (usually, using +`dvc metrics modify` command). If `-t` is not specified `-x` is ignored. The +type can be detected by the file extension automatically if the type is +supported. ## Options @@ -71,11 +72,9 @@ the file extension automatically if the type is supported. can be used to compare different variants of an experiment if tags are used for checkpoints. -- `-R`, `--recursive` - if `path` is a directory, recursively search and process - all metric files in path. If `path` is a file it is processed as a regular - metric file. This is done to tolerate the difference across branches or tags - when `-a` or `-T` options are used. For example, if `path` is a directory in - one branch and a regular file in another. +- `-R`, `--recursive` - `path` is expected to be a directory for this option to + have effect. Determines the metric files to show by searching each target + directory and its subdirectories for DVC-files to inspect. ## Examples diff --git a/static/docs/commands-reference/pipeline.md b/static/docs/commands-reference/pipeline.md index 7868b501a5..5e47f7190e 100644 --- a/static/docs/commands-reference/pipeline.md +++ b/static/docs/commands-reference/pipeline.md @@ -1,6 +1,6 @@ # pipeline -A set of commands to manage pipelines: +A set of commands to manage [pipelines](/doc/get-started/pipeline): [show](/doc/commands-reference/pipeline-show) - visualize or [list](/doc/commands-reference/pipeline-list) - list existing pipelines. @@ -17,7 +17,19 @@ positional arguments: ## Description -Manage pipeline. +A data pipeline, in general, is a chain of commands that process data files. It +produces intermediate data and a final result. For example, Machine Learning +(ML) pipelines typically start a with large raw datasets, include featurization +and training intermediate stages, and produce a final model, as well as certain +metrics. + +In DVC, pipeline stage files and commands, their data I/O, interdependencies, +and results (intermediate or final) are defined with `dvc add` and `dvc run`, +among other commands. This allows us to form one or more pipelines of stages +connected by their dependencies and outputs. + +`dvc pipeline` commands help users display the existing project pipelines in +different ways. ## Options diff --git a/static/docs/commands-reference/pipeline_list.md b/static/docs/commands-reference/pipeline_list.md index 13571a02f0..2b213c4842 100644 --- a/static/docs/commands-reference/pipeline_list.md +++ b/static/docs/commands-reference/pipeline_list.md @@ -9,18 +9,34 @@ are independent of each other. usage: dvc pipeline list [-h] [-q | -v] ``` +## Description + +`dvc list` displays a list of all existing stages in the project, grouped in +their corresponding pipeline(s) when connected. (See `dvc pipeline`.) + +> Note that the stages in these lists are in ascending order, that is, from last +> to first. + +## Options + +- `-h`, `--help` - prints the usage/help message, and exit. + +- `-q`, `--quiet` - do not write anything to standard output. Exit with 0 if no + problems arise, otherwise 1. + +- `-v`, `--verbose` - displays detailed tracing information. + ## Examples - List available pipelines: ```dvc $ dvc pipeline list - Dvcfile -=============== +====================================================================== raw.dvc data.dvc output.dvc - +====================================================================== 2 pipeline(s) total ``` diff --git a/static/docs/commands-reference/pipeline_show.md b/static/docs/commands-reference/pipeline_show.md index 35eaf76ea1..0c1f6d632c 100644 --- a/static/docs/commands-reference/pipeline_show.md +++ b/static/docs/commands-reference/pipeline_show.md @@ -4,9 +4,6 @@ Show [stages](/doc/commands-reference/run) in a pipeline that lead to the specified stage. By default it lists [DVC-files](/doc/user-guide/dvc-file-format). -The `-c` and `-o` options allow to list or visualize a pipeline commands or data -files flow instead. - ## Synopsis ```usage @@ -15,9 +12,20 @@ usage: dvc pipeline show [-h] [-q | -v] [-c | -o] [-l] [--ascii] [targets [targets ...]] positional arguments: - targets DVC-files. 'Dvcfile' by default. + targets DVC-files to show pipeline for. Optional. + (Finds all DVC-files in the workspace by default.) ``` +## Description + +`dvc show` displays the stages of a pipeline up to one or more target DVC-files +(stage files). If specific `targets` are omitted, `Dvcfile` will be assumed. The +`-c` and `-o` options allow to list the corresponding commands or data file flow +instead of stages. + +> Note that the stages in these lists are in descending order, that is, from +> first to last. + ## Options - `-c`, `--commands` - show pipeline as a list (graph, if `--ascii` or `--dot` @@ -36,13 +44,19 @@ positional arguments: - `-l`, `--locked` - print locked stages only. See `dvc lock`. +- `-h`, `--help` - prints the usage/help message, and exit. + +- `-q`, `--quiet` - do not write anything to standard output. Exit with 0 if no + problems arise, otherwise 1. + +- `-v`, `--verbose` - displays detailed tracing information. + ## Examples - Default mode: show stage files that `output.dvc` recursively depends on: ```dvc $ dvc pipeline show output.dvc - raw.dvc data.dvc output.dvc @@ -52,7 +66,6 @@ positional arguments: ```dvc $ dvc pipeline show output.dvc --commands - download.py s3://mybucket/myrawdata raw cleanup.py raw data process.py data output diff --git a/static/docs/commands-reference/pull.md b/static/docs/commands-reference/pull.md index 579af2cb72..bd74a7aea5 100644 --- a/static/docs/commands-reference/pull.md +++ b/static/docs/commands-reference/pull.md @@ -2,7 +2,8 @@ Downloads missing files and directories from [remote storage](/doc/commands-reference/remote) to the local cache based on -DVC-files in the workspace, then links the downloaded files into the workspace. +[DVC-files](/doc/user-guide/dvc-file-format) in the workspace, then links the +downloaded files into the workspace. ## Synopsis @@ -12,7 +13,8 @@ usage: dvc pull [-h] [-q | -v] [-j JOBS] [--show-checksums] [targets [targets ...]] positional arguments: - targets DVC files. + targets Limit command scope to these DVC-files. Using -R, + directories to search DVC-files in can also be given. ``` ## Description @@ -79,11 +81,9 @@ reflinks or hardlinks to put it in the workspace without copying. See backward from the target stage(s) in the corresponding pipeline(s). This means DVC will not pull files referenced in later stage(s) than `targets`. -- `-R`, `--recursive` - `targets` values is expected to be a directory path. - Determines the files to download by searching the named directory and its - subdirectories for DVC-files to download data for. Along with providing a - `target`, or `target` along with `--with-deps` it is yet another way to cut - the scope of DVC-files to download. +- `-R`, `--recursive` - `targets` is expected to contain at least one directory + path for this option to have effect. Determines the files to pull by searching + each target directory and its subdirectories for DVC-files to inspect. - `-f`, `--force` - does not prompt when removing working directory files, which occurs during the process of updating the workspace. This option surfaces diff --git a/static/docs/commands-reference/push.md b/static/docs/commands-reference/push.md index 4ea1112845..ada58475c4 100644 --- a/static/docs/commands-reference/push.md +++ b/static/docs/commands-reference/push.md @@ -11,7 +11,8 @@ usage: dvc push [-h] [-q | -v] [-j JOBS] [--show-checksums] [targets [targets ...]] positional arguments: - targets DVC files. + targets Limit command scope to these DVC-files. Using -R, + directories to search DVC-files in can also be given. ``` ## Description @@ -89,11 +90,9 @@ to push. backward from the target stage(s) in the corresponding pipeline(s). This means DVC will not push files referenced in later stage(s) than `targets`. -- `-R`, `--recursive` - `targets` is expected to contain directory path(s). - Determines the files to upload by searching each target directory and its - subdirectories for DVC-files to inspect. Along with providing a `target`, or - `target` and `--with-deps`, this is another way to limit the scope of - DVC-files to upload. +- `-R`, `--recursive` - `targets` is expected to contain at least one directory + path for this option to have effect. Determines the files to push by searching + each target directory and its subdirectories for DVC-files to inspect. - `-j JOBS`, `--jobs JOBS` - specifies number of jobs to run simultaneously while uploading files to the remote cache. The effect is to control the number diff --git a/static/docs/commands-reference/remote_add.md b/static/docs/commands-reference/remote_add.md index 9cd3fa136a..e772e3d736 100644 --- a/static/docs/commands-reference/remote_add.md +++ b/static/docs/commands-reference/remote_add.md @@ -17,7 +17,7 @@ usage: dvc remote add [-h] [--global] [--system] [--local] [-q | -v] [-d] [-f] name url positional arguments: - name Name. + name Name of the remote. url URL. (See supported URLs below.) ``` diff --git a/static/docs/commands-reference/remove.md b/static/docs/commands-reference/remove.md index 97299118b5..6c3459df16 100644 --- a/static/docs/commands-reference/remove.md +++ b/static/docs/commands-reference/remove.md @@ -15,7 +15,8 @@ want to use or share in the future. usage: dvc remove [-h] [-q | -v] [-o | -p] [-f] targets [targets ...] positional arguments: - targets DVC-files. + targets DVC-files to remove. Optional. (Finds all + DVC-files in the workspace by default.) ``` Check also [Update Tracked Files](/doc/user-guide/update-tracked-file) to see diff --git a/static/docs/commands-reference/repro.md b/static/docs/commands-reference/repro.md index 39316ef785..b6eb5dc572 100644 --- a/static/docs/commands-reference/repro.md +++ b/static/docs/commands-reference/repro.md @@ -13,7 +13,7 @@ usage: dvc repro [-h] [-q | -v] [-f] [-s] [-c CWD] [-m] [--dry] [-i] [--downstream] [targets [targets ...]] positional arguments: - targets DVC file to reproduce (default - 'Dvcfile'). + targets DVC-file to reproduce. 'Dvcfile' by default. ``` ## Description @@ -57,6 +57,11 @@ specified), and updates stage files with the new checksum information. reproduced as part of the pipeline in the parent directory, or as an independent unit. +- `-R`, `--recursive` - `targets` is expected to contain at least one directory + path for this option to have effect. Determines the stages to reproduce by + searching each target directory and its subdirectories for DVC-files to + inspect. + - `--no-commit` - do not save outputs to cache. Useful when running different experiments and you don't want to fill up your cache with temporary files. Use `dvc commit` when you are ready to save your results to cache. diff --git a/static/docs/commands-reference/run.md b/static/docs/commands-reference/run.md index c273a350d4..1e78c8fda9 100644 --- a/static/docs/commands-reference/run.md +++ b/static/docs/commands-reference/run.md @@ -20,16 +20,19 @@ positional arguments: ## Description -`dvc run` provides an interface to build a computational graph (aka pipeline). -It's a way to describe commands, data inputs and intermediate results that went -into a model (or other data results). By explicitly specifying a list of -dependencies (with `-d` option) and outputs (with `-o`, `-O`, `-m`, or `-M` -options) DVC can connect individual stages (commands) into a directed acyclic -graph (DAG). `dvc repro` provides an interface to check state and reproduce this -graph later. This concept is similar to the one of the `Makefile` but DVC -captures data and caches data artifacts along the way. Check this -[example](/doc/get-started/example-pipeline) to learn more and try to build a -pipeline. +`dvc run` provides an interface to build a computational graph (a.k.a. +pipeline). It's a way to describe commands, data inputs and intermediate results +that go into creating a ML model (or other data results). By explicitly +specifying a list of dependencies (with `-d` option) and outputs (with `-o`, +`-O`, `-m`, or `-M` options) DVC can connect each individual stage (command) +into a directed acyclic graph (DAG). All the remainder of command-line input +provided to `dvc run` after the optional arguments (`-` or `--` dashed options) +will become the required `command` argument. + +> Remember to wrap the `command` with `"` quotes if there are special characters +> in it like `|` (pipe) or `<`, `>` (redirection) that would otherwise apply to +> the entire `dvc run` command. E.g. +> `dvc run -d script.sh "script.sh > /dev/null 2>&1"` Unless the `-f` options is used, by default the DVC-file name generated is `.dvc`, where `` is file name of the first output (`-o`, `-O`, `-m`, @@ -42,6 +45,12 @@ graph integrity properties before creating a new stage. For example, for every output there should be only one stage that explicitly specifies it. There should be no cycles, etc. +Note that `dvc repro` provides an interface to check state and reproduce this +graph later. This concept is similar to the one of the `Makefile` but DVC +captures data and caches data artifacts along the way. Check this +[example](/doc/get-started/example-pipeline) to learn more and try to build a +pipeline. + ## Options - `-d`, `--deps` - specify a file or a directory the stage depends on. Multiple diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index 8387265238..83f7290c11 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -12,7 +12,8 @@ usage: dvc status [-h] [-v] [-j JOBS] [--show-checksums] [-q] [-c] [targets [targets ...]] positional arguments: - targets DVC files. + targets Limit command scope to these DVC-files. Using -R, + directories to search DVC-files in can also be given. ``` ## Description @@ -30,11 +31,12 @@ synchronize them). The two modes, _local_ and _cloud_ are triggered by using the | remote | `--remote` | Comparisons are made between the local cache, and the given remote. Remote caches are defined using the `dvc remote` command. | | remote | `--cloud` | Comparisons are made between the local cache, and the default remote, defined with `dvc remote --default` command. | -DVC determines data and code files to compare by analyzing all DVC-files in the -current workspace (`--all-branches` and `--all-tags` in the `cloud` mode compare -multiple workspaces - across all branches or tags). The comparison can be -limited to specific DVC-files by listing them as `targets`. Changes are reported -only against the given `targets`. When combined with the `--with-deps` option, a +DVC determines data and code files to compare by analyzing all +[DVC-files](/doc/user-guide/dvc-file-format) in the current workspace +(`--all-branches` and `--all-tags` in the `cloud` mode compare multiple +workspaces - across all branches or tags). The comparison can be limited to +specific DVC-files by listing them as `targets`. Changes are reported only +against the given `targets`. When combined with the `--with-deps` option, a search is made for changes in other stages that affect the target. In the `local` mode, changes are detected through the checksum of every file diff --git a/static/docs/commands-reference/unlock.md b/static/docs/commands-reference/unlock.md index 0e98d07d8c..679e273624 100644 --- a/static/docs/commands-reference/unlock.md +++ b/static/docs/commands-reference/unlock.md @@ -9,7 +9,7 @@ Unlock [DVC-file](/doc/user-guide/dvc-file-format) usage: dvc unlock [-h] [-q | -v] targets [targets ...] positional arguments: - targets DVC-files. + targets DVC-files to unlock. ``` ## Options diff --git a/static/docs/commands-reference/unprotect.md b/static/docs/commands-reference/unprotect.md index 15e82b178c..8e127ccd31 100644 --- a/static/docs/commands-reference/unprotect.md +++ b/static/docs/commands-reference/unprotect.md @@ -9,7 +9,7 @@ enabled with `dvc config cache`). usage: dvc unlock [-h] [-q | -v] targets [targets ...] positional arguments: - targets DVC-files. + targets Data files/directories to unprotect. ``` ## Description diff --git a/static/docs/get-started/index.md b/static/docs/get-started/index.md index e41787c8e0..9db6fbd937 100644 --- a/static/docs/get-started/index.md +++ b/static/docs/get-started/index.md @@ -6,7 +6,7 @@ go into details much, but provides links and expandable sections to learn more. At the very end there are a few complete step-by-step examples to give you more hands-on experience with real-life scenarios - first is about model and data set [versioning](/doc/get-started/example-versioning), and the second one is focused -on [pipelines](/doc/get-started/example-pipeline) and reproducibility. +on [pipelines and reproducibility](/doc/get-started/example-pipeline). ✅ Please, join our [community](/chat) or check these [support](/support) options if you have any questions or need any help. We are very responsive ⚡. diff --git a/static/docs/get-started/pipeline.md b/static/docs/get-started/pipeline.md index 45b4e64f8b..5f4776b55c 100644 --- a/static/docs/get-started/pipeline.md +++ b/static/docs/get-started/pipeline.md @@ -1,13 +1,14 @@ # Pipeline -This is the biggest difference between DVC and other version control tools that -can handle large data files, e.g. `git lfs`. By running `dvc run` multiple times -and specifying outputs of a command (stage) as dependencies in another command -(stage) we can, essentially, describe a sequence of commands that is required to -get to the final result: +Support for [pipelines](/doc/commands-reference/pipeline) is the biggest +difference between DVC and other version control tools that can handle large +data files (e.g. `git lfs`). By using `dvc run` multiple times, and specifying +outputs of a command (stage) as dependencies in another one, we can describe a +sequence of commands that gets to a desired result. This is what we call a +**data pipeline** or computational graph. -The second stage (after the `prepare.dvc` that we created during the previous -step), feature extraction: +Lets create a second stage (after `prepare.dvc`, created in the previous +chapter) to perform feature extraction: ```dvc $ dvc run -f featurize.dvc \ @@ -17,7 +18,7 @@ $ dvc run -f featurize.dvc \ data/prepared data/features ``` -The third stage, training: +And a third stage for training: ```dvc $ dvc run -f train.dvc \ diff --git a/static/docs/user-guide/external-outputs.md b/static/docs/user-guide/external-outputs.md index d3edc8fc84..be60d51713 100644 --- a/static/docs/user-guide/external-outputs.md +++ b/static/docs/user-guide/external-outputs.md @@ -2,9 +2,9 @@ You can specify external files as outputs for [DVC-files](/doc/user-guide/dvc-file-format) created by `dvc run` (stage files). -DVC will track changes in those files and will reflect so in your -[pipeline status](/doc/commands-reference/status). Currently DVC supports these -types of external outputs: +DVC will track changes in those files and will reflect so in your pipeline +[status](/doc/commands-reference/status). Currently DVC supports these types of +external outputs: 1. Local files and directories outside of your dvc repository; 2. Amazon S3; diff --git a/static/docs/user-guide/large-dataset-optimization.md b/static/docs/user-guide/large-dataset-optimization.md index ce9210e2b3..d4ea0fe495 100644 --- a/static/docs/user-guide/large-dataset-optimization.md +++ b/static/docs/user-guide/large-dataset-optimization.md @@ -80,7 +80,7 @@ efficiency: > instead deleted and then replaced with a new file, otherwise it might cause > cache corruption – and automatic deletion of cached files by DVC. -3. **`symlink`** - symbolic (aka "soft") links are the most efficient way to +3. **`symlink`** - symbolic (a.k.a. "soft") links are the most efficient way to link your data to cache if your repo and your cache directory are located on different file systems/drives (i.e. repo is located on SSD for performance, but cache dir is located on HDD for bigger storage).