diff --git a/content/docs/command-reference/add.md b/content/docs/command-reference/add.md index c140911037..dcfde437a0 100644 --- a/content/docs/command-reference/add.md +++ b/content/docs/command-reference/add.md @@ -68,7 +68,7 @@ You can also [undo `dvc add`](/doc/user-guide/how-to/stop-tracking-data) to stop tracking files or directories. By default, DVC tries to use reflinks (see -[File link types](/doc/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache) +[File link types](/doc/user-guide/data-management/large-dataset-optimization#file-link-types-for-the-dvc-cache) to avoid copying any file contents and to optimize `.dvc` file operations for large files. DVC also supports other link types for use on file systems without `reflink` support, but they have to be specified manually. Refer to the @@ -149,7 +149,7 @@ not. - `--external` - allow tracking `targets` outside of the DVC repository in-place. See - [Managing External Data](/doc/user-guide/managing-external-data). + [Managing External Data](/doc/user-guide/data-management/managing-external-data). > ⚠️ Note that this is an advanced feature for very specific situations and > not recommended except if there's absolutely no other alternative. @@ -384,9 +384,9 @@ outs: ``` [linked]: - /doc/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache + /doc/user-guide/data-management/large-dataset-optimization#file-link-types-for-the-dvc-cache [external cache]: - /doc/user-guide/managing-external-data#setting-up-an-external-cache + /doc/user-guide/data-management/managing-external-data#setting-up-an-external-cache ## Example: Transfer to remote storage diff --git a/content/docs/command-reference/cache/index.md b/content/docs/command-reference/cache/index.md index ef39762760..a738c7e50d 100644 --- a/content/docs/command-reference/cache/index.md +++ b/content/docs/command-reference/cache/index.md @@ -18,7 +18,7 @@ Tracked files and directories visible in the workspace are links\* to the ones in the project's cache. > \* Or copies. Refer to -> [File link types](/doc/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache) +> [File link types](/doc/user-guide/data-management/large-dataset-optimization#file-link-types-for-the-dvc-cache) > for more information on supported linking on different platforms. For cache configuration options, refer to `dvc config cache`. diff --git a/content/docs/command-reference/checkout.md b/content/docs/command-reference/checkout.md index 5da65adcd6..4ba50a7256 100644 --- a/content/docs/command-reference/checkout.md +++ b/content/docs/command-reference/checkout.md @@ -46,7 +46,7 @@ for more details. By default, this command tries not make copies of cached files in the workspace, using reflinks instead when supported by the file system (refer to -[File link types](/doc/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache)). +[File link types](/doc/user-guide/data-management/large-dataset-optimization#file-link-types-for-the-dvc-cache)). The next linking strategy default value is `copy` though, so unless other file link types are manually configured in `cache.type` (using `dvc config`), files will be copied. Keep in mind that having file copies doesn't present much of a diff --git a/content/docs/command-reference/config.md b/content/docs/command-reference/config.md index a52bc06c9b..b311fddd3b 100644 --- a/content/docs/command-reference/config.md +++ b/content/docs/command-reference/config.md @@ -180,7 +180,7 @@ See `dvc remote add` and `dvc remote modify` for more information. `dvc unprotect` to be able to modify them safely. There are pros and cons to different link types. Refer to - [File link types](/doc/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache) + [File link types](/doc/user-guide/data-management/large-dataset-optimization#file-link-types-for-the-dvc-cache) for a full explanation of each one. To apply changes to this config option in the workspace, restore all file @@ -204,7 +204,7 @@ See `dvc remote add` and `dvc remote modify` for more information. [`os.umask`](https://docs.python.org/3/library/os.html#os.umask). The following parameters allow setting an -[external cache](/doc/user-guide/managing-external-data#setting-up-an-external-cache) +[external cache](/doc/user-guide/data-management/managing-external-data#setting-up-an-external-cache) location. A [DVC remote](/doc/command-reference/remote) name is used (instead of the URL) because often it's necessary to configure authentication or other connection settings, and configuring a remote is the way that can be done. diff --git a/content/docs/command-reference/dag.md b/content/docs/command-reference/dag.md index 5519861ab4..41293ab798 100644 --- a/content/docs/command-reference/dag.md +++ b/content/docs/command-reference/dag.md @@ -35,7 +35,7 @@ This command's output is automatically piped to is not available (e.g. on Windows), the output is simply printed out. > It's also possible to -> [enable `less` on Windows](/doc/user-guide/running-dvc-on-windows#enabling-paging-with-less). +> [enable `less` on Windows](/doc/user-guide/how-to/run-dvc-on-windows#enabling-paging-with-less). > Note that this also applies to `dvc exp show`. diff --git a/content/docs/command-reference/destroy.md b/content/docs/command-reference/destroy.md index b114d9067d..ed4e61889d 100644 --- a/content/docs/command-reference/destroy.md +++ b/content/docs/command-reference/destroy.md @@ -17,14 +17,15 @@ directory from the project. Note that the cache directory will be removed as well, unless it's set to an -[external location](/doc/user-guide/managing-external-data#setting-up-an-external-cache) +[external location](/doc/user-guide/data-management/managing-external-data#setting-up-an-external-cache) (by default a local cache is located in `.dvc/cache`). If you have setup -[symlinks](/doc/user-guide/large-dataset-optimization) (from cache to workspace) -in your project, DVC will replace them with the latest versions of the actual -files and directories first, so that your data is intact after destruction. +[symlinks](/doc/user-guide/data-management/large-dataset-optimization) (from +cache to workspace) in your project, DVC will replace them with the latest +versions of the actual files and directories first, so that your data is intact +after destruction. [external cache]: - /doc/user-guide/managing-external-data#setting-up-an-external-cache + /doc/user-guide/data-management/managing-external-data#setting-up-an-external-cache > Refer to [Project Structure](/doc/user-guide/project-structure) for more > details on the directories and files deleted by this command. diff --git a/content/docs/command-reference/exp/show.md b/content/docs/command-reference/exp/show.md index f22f736e02..ff0cd84b31 100644 --- a/content/docs/command-reference/exp/show.md +++ b/content/docs/command-reference/exp/show.md @@ -1,10 +1,13 @@ # exp show -Displays your experiments in a customizable table or -[parallel coordinates plot](/doc/user-guide/experiment-management/comparing-experiments#parallel-coordinates-plot). +Displays your experiments in a customizable table or [parallel coordinates +plot]. > Press `q` to exit. +[parallel coordinates plot]: + /doc/user-guide/experiment-management/comparing-experiments#parallel-coordinates-plot + ## Synopsis ```usage @@ -58,8 +61,7 @@ sorted inside each group, chronologically by default. The `--sort-by` and `--sort-order` options can change this ordering, based on any single, visible metric or param. -When the `--pcp` option is passed, an interactive -[parallel coordinates plot](/doc/user-guide/experiment-management/comparing-experiments#parallel-coordinates-plot) +When the `--pcp` option is passed, an interactive [parallel coordinates plot] will be generated using the same data from the table. ![](/img/pcp_interaction.gif) _Parallel Coordinates Plot_ @@ -72,7 +74,7 @@ This command's output is automatically piped to is not available (e.g. on Windows), the output is simply printed out. > It's also possible to -> [enable `less` on Windows](/doc/user-guide/running-dvc-on-windows#enabling-paging-with-less). +> [enable `less` on Windows](/doc/user-guide/how-to/run-dvc-on-windows#enabling-paging-with-less). ### Providing a custom pager diff --git a/content/docs/command-reference/fetch.md b/content/docs/command-reference/fetch.md index 17e2f872dd..783d4e6216 100644 --- a/content/docs/command-reference/fetch.md +++ b/content/docs/command-reference/fetch.md @@ -47,9 +47,9 @@ Here are some scenarios in which `dvc fetch` is useful, instead of pulling: DVC-tracked data from multiple project branches or tags into your machine. - To use comparison commands across different Git commits, for example `dvc metrics show` with its `--all-branches` option, or `dvc plots diff`. -- If you want to avoid [linking](/doc/user-guide/large-dataset-optimization) - files from the cache, or keep the workspace clean for any other - reason. +- If you want to avoid + [linking](/doc/user-guide/data-management/large-dataset-optimization) files + from the cache, or keep the workspace clean for any other reason. Without arguments, it downloads all files and directories referenced in the current workspace (found in `dvc.yaml` and `.dvc` files) that are missing from diff --git a/content/docs/command-reference/import-url.md b/content/docs/command-reference/import-url.md index 0cc35697ce..29c82d859b 100644 --- a/content/docs/command-reference/import-url.md +++ b/content/docs/command-reference/import-url.md @@ -70,11 +70,11 @@ update the import later, if the data source has changed (see `dvc update`). > `dvc import`). `.dvc` files support references to data in an external location, see -[External Dependencies](/doc/user-guide/external-dependencies). In such an -import `.dvc` file, the `deps` field stores the external URL, and the `outs` -field contains the corresponding local path in the workspace. It -records enough metadata about the imported data to enable DVC efficiently -determining whether the local copy is out of date. +[External Dependencies](/doc/user-guide/data-management/importing-external-data). +In such an import `.dvc` file, the `deps` field stores the external URL, and the +`outs` field contains the corresponding local path in the +workspace. It records enough metadata about the imported data to +enable DVC efficiently determining whether the local copy is out of date. Note that `dvc repro` doesn't check or update import `.dvc` files, use `dvc update` to bring the import up to date from the data source. @@ -113,8 +113,8 @@ generating a pipeline [stage](/doc/command-reference/run) with an external dependency. > This is discussed in the -> [External Dependencies](/doc/user-guide/external-dependencies) documentation, -> where an alternative is demonstrated for each of these schemes. +> [External Dependencies](/doc/user-guide/data-management/importing-external-data) +> documentation, where an alternative is demonstrated for each of these schemes. Instead of: diff --git a/content/docs/command-reference/list.md b/content/docs/command-reference/list.md index e004dee7c4..1b77afc6ae 100644 --- a/content/docs/command-reference/list.md +++ b/content/docs/command-reference/list.md @@ -153,8 +153,9 @@ $ git archive -o code.zip HEAD $ dvc list . -R --dvc-only | zip -@ data.zip ``` -ZIP alternative for [POSIX on Windows](/doc/user-guide/running-dvc-on-windows) -(Python installed): +ZIP alternative for +[POSIX on Windows](/doc/user-guide/how-to/run-dvc-on-windows) (Python +installed): ```dvc $ dvc list . -R --dvc-only | xargs python -m zipfile -c data.zip diff --git a/content/docs/command-reference/move.md b/content/docs/command-reference/move.md index 49c6fe6276..0059d74338 100644 --- a/content/docs/command-reference/move.md +++ b/content/docs/command-reference/move.md @@ -24,7 +24,7 @@ the project with `dvc add` or `dvc import`, creating a `.dvc` file `dvc.yaml`), they have to be [renamed manually](#renaming-stage-outputs). > Note that `src` itself may be either a -> [link](/doc/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache) +> [link](/doc/user-guide/data-management/large-dataset-optimization#file-link-types-for-the-dvc-cache) > or a copy to the corresponding data in the cache. The cached file > is not changed by this command. diff --git a/content/docs/command-reference/plots/diff.md b/content/docs/command-reference/plots/diff.md index 6a030c2f4c..534d699904 100644 --- a/content/docs/command-reference/plots/diff.md +++ b/content/docs/command-reference/plots/diff.md @@ -47,7 +47,8 @@ option. To learn more about plots files and templates please see `dvc plots`. Another way to display plots is the `dvc plots show` command, which just lists all the current plots, without comparisons. -[certain metrics]: /doc/user-guide/visualizing-plots#supported-plot-file-formats +[certain metrics]: + /doc/user-guide/experiment-management/visualizing-plots#supported-plot-file-formats [plot templates]: /doc/user-guide/experiment-management/visualizing-plots#plot-templates-data-series-only @@ -69,7 +70,7 @@ all the current plots, without comparisons. [`plots.out_dir`](/doc/command-reference/config#plots) config option. - `-t , --template ` - - [plot template](/doc/user-guide/visualizing-plots#plot-templates-data-series-only) + [plot template](/doc/user-guide/experiment-management/visualizing-plots#plot-templates-data-series-only) to be injected with data. The default template is `.dvc/plots/default.json`. See more details in `dvc plots`. @@ -150,7 +151,7 @@ cat,turtle ``` The predefined confusion matrix -[template](/doc/user-guide/visualizing-plots#plot-templates-data-series-only) +[template](/doc/user-guide/experiment-management/visualizing-plots#plot-templates-data-series-only) (in `.dvc/plots/confusion.json`) shows how metrics comparisons can be faceted by separate plots. It can be enabled with `-t` (`--template`): diff --git a/content/docs/command-reference/plots/index.md b/content/docs/command-reference/plots/index.md index 5e508db705..da9348b971 100644 --- a/content/docs/command-reference/plots/index.md +++ b/content/docs/command-reference/plots/index.md @@ -39,7 +39,7 @@ Plots have to be defined either at the stage level, or at the pipeline level in See [Visualizing Plots] and [Top-level plot definitions] for more details -[visualizing plots]: /doc/user-guide/visualizing-plots +[visualizing plots]: /doc/user-guide/experiment-management/visualizing-plots [top-level plot definitions]: /doc/user-guide/project-structure/dvcyaml-files#top-level-plot-definitions diff --git a/content/docs/command-reference/plots/modify.md b/content/docs/command-reference/plots/modify.md index 1e737ab6d6..a22c54c3ac 100644 --- a/content/docs/command-reference/plots/modify.md +++ b/content/docs/command-reference/plots/modify.md @@ -6,7 +6,8 @@ defined in stages. > ⚠️ Note that this command can modify only data-series plots. It has no effect > on image-type plots or any [top-level plot] definitions. -[top-level plot]: /doc/user-guide/visualizing-plots#top-level-plots +[top-level plot]: + /doc/user-guide/experiment-management/visualizing-plots#top-level-plots ## Synopsis @@ -44,7 +45,7 @@ Note that a secondary use of this command is to convert output or simple ## Options - `-t , --template ` - set a default - [plot template](/doc/user-guide/visualizing-plots#plot-templates-data-series-only). + [plot template](/doc/user-guide/experiment-management/visualizing-plots#plot-templates-data-series-only). - `-x ` - set a default field or column name (or number) from which the X axis data comes from. diff --git a/content/docs/command-reference/plots/show.md b/content/docs/command-reference/plots/show.md index dfeda758da..fd95f155a7 100644 --- a/content/docs/command-reference/plots/show.md +++ b/content/docs/command-reference/plots/show.md @@ -3,7 +3,8 @@ Generate [plot](/doc/command-reference/plots) from a plots file or `plots` [top-level definition] from `dvc.yaml`. -[top-level definition]: /doc/user-guide/visualizing-plots#top-level-plots +[top-level definition]: + /doc/user-guide/experiment-management/visualizing-plots#top-level-plots ## Synopsis @@ -38,11 +39,13 @@ The default behavior of this command can be modified per [stage plot] file with -[certain data]: /doc/user-guide/visualizing-plots#supported-plot-file-formats +[certain data]: + /doc/user-guide/experiment-management/visualizing-plots#supported-plot-file-formats [plot templates]: - /doc/user-guide/visualizing-plots#plot-templates-data-series-only -[top-level plot]: /doc/user-guide/visualizing-plots#top-level-plots -[stage plot]: /doc/user-guide/visualizing-plots + /doc/user-guide/experiment-management/visualizing-plots#plot-templates-data-series-only +[top-level plot]: + /doc/user-guide/experiment-management/visualizing-plots#top-level-plots +[stage plot]: /doc/user-guide/experiment-management/visualizing-plots ## Options @@ -51,7 +54,7 @@ The default behavior of this command can be modified per [stage plot] file with [`plots.out_dir`](/doc/command-reference/config#plots) config option. - `-t , --template ` - - [plot template](/doc/user-guide/visualizing-plots#plot-templates-data-series-only) + [plot template](/doc/user-guide/experiment-management/visualizing-plots#plot-templates-data-series-only) to be injected with data. The default template is `.dvc/plots/default.json`. See more details in `dvc plots`. @@ -480,7 +483,7 @@ file:///Users/usr/src/dvc_plots/index.html ![](/img/plots_show_confusion.svg) > A confusion matrix -> [template](/doc/user-guide/visualizing-plots#plot-templates-data-series-only) +> [template](/doc/user-guide/experiment-management/visualizing-plots#plot-templates-data-series-only) > is predefined in DVC. We can use `confusion_normalized` template to normalize the results: diff --git a/content/docs/command-reference/plots/templates.md b/content/docs/command-reference/plots/templates.md index 7b99c7e076..bdd57ea12a 100644 --- a/content/docs/command-reference/plots/templates.md +++ b/content/docs/command-reference/plots/templates.md @@ -73,9 +73,9 @@ important fields that DVC adds to the plot data: [plot templates]: - https://dvc.org/doc/user-guide/visualizing-plots#plot-templates-data-series-only + https://dvc.org/doc/user-guide/experiment-management/visualizing-plots#plot-templates-data-series-only [vega-lite specification]: https://vega.github.io/vega-lite/ -[data-series plots]: /doc/user-guide/visualizing-plots +[data-series plots]: /doc/user-guide/experiment-management/visualizing-plots ## Example: Modifying the `simple` template diff --git a/content/docs/command-reference/remote/add.md b/content/docs/command-reference/remote/add.md index 867d75ca17..28d14b46db 100644 --- a/content/docs/command-reference/remote/add.md +++ b/content/docs/command-reference/remote/add.md @@ -168,9 +168,9 @@ To use a custom authentication method, use the parameters described in ### Google Drive To start using a GDrive remote, first add it with a -[valid URL format](/doc/user-guide/setup-google-drive-remote#url-format). Then -use any DVC command that needs to connect to it (e.g. `dvc pull` or `dvc push` -once there's tracked data to synchronize). For example: +[valid URL format](/doc/user-guide/how-to/setup-google-drive-remote#url-format). +Then use any DVC command that needs to connect to it (e.g. `dvc pull` or +`dvc push` once there's tracked data to synchronize). For example: ```cli $ dvc remote add -d myremote gdrive://0AIac4JZqHhKmUk9PDA/dvcstore @@ -184,7 +184,7 @@ Enter verification code: # <- enter resulting code ``` See `dvc remote modify` for a list of other GDrive parameters, or -[Set up a Google Drive DVC Remote](/doc/user-guide/setup-google-drive-remote) +[Set up a Google Drive DVC Remote](/doc/user-guide/how-to/setup-google-drive-remote) for a full guide on using Google Drive as DVC remote storage. Note that GDrive remotes are not "trusted" by default. This means that the diff --git a/content/docs/command-reference/remote/modify.md b/content/docs/command-reference/remote/modify.md index 072aec9147..e73d0826b8 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -559,11 +559,11 @@ can propagate from an Azure configuration file (typically managed with > file. Please see -[Set up a Google Drive DVC Remote](/doc/user-guide/setup-google-drive-remote) +[Set up a Google Drive DVC Remote](/doc/user-guide/how-to/setup-google-drive-remote) for a full guide on using Google Drive as DVC remote storage. - `url` - remote location. See - [valid URL format](/doc/user-guide/setup-google-drive-remote#url-format). + [valid URL format](/doc/user-guide/how-to/setup-google-drive-remote#url-format). ```dvc $ dvc remote modify myremote url \ @@ -571,7 +571,7 @@ for a full guide on using Google Drive as DVC remote storage. ``` - `gdrive_client_id` - Client ID for authentication with OAuth 2.0 when using a - [custom Google Client project](/doc/user-guide/setup-google-drive-remote#using-a-custom-google-cloud-project-recommended). + [custom Google Client project](/doc/user-guide/how-to/setup-google-drive-remote#using-a-custom-google-cloud-project-recommended). Also requires using `gdrive_client_secret`. ```dvc @@ -607,8 +607,9 @@ for a full guide on using Google Drive as DVC remote storage. gdrive_user_credentials_file path/to/mycredentials.json ``` -See [Authorization](/doc/user-guide/setup-google-drive-remote#authorization) for -more details. +See +[Authorization](/doc/user-guide/how-to/setup-google-drive-remote#authorization) +for more details. - `gdrive_trash_only` - configures `dvc gc` to move remote files to [trash](https://developers.google.com/drive/api/v2/reference/files/trash) diff --git a/content/docs/command-reference/run.md b/content/docs/command-reference/run.md index 6682139833..4751b2c024 100644 --- a/content/docs/command-reference/run.md +++ b/content/docs/command-reference/run.md @@ -87,9 +87,10 @@ Relevant notes: [Structure of cache directory](/doc/user-guide/project-structure/internal-files#structure-of-the-cache-directory) for more info.) -- [external dependencies](/doc/user-guide/external-dependencies) and - [external outputs](/doc/user-guide/managing-external-data) (outside of the - workspace) are also supported (except metrics and plots). +- [external dependencies](/doc/user-guide/data-management/importing-external-data) + and [external outputs](/doc/user-guide/data-management/managing-external-data) + (outside of the workspace) are also supported (except metrics and + plots). - Outputs are deleted from the workspace before executing the command (including at `dvc repro`) if their paths are found as existing files/directories (unless @@ -135,7 +136,7 @@ data science experiments. on. Multiple dependencies can be specified like this: `-d data.csv -d process.py`. Usually, each dependency is a file or a directory with data, or a code file, or a configuration file. DVC also supports certain - [external dependencies](/doc/user-guide/external-dependencies). + [external dependencies](/doc/user-guide/data-management/importing-external-data). When you use `dvc repro`, the list of dependencies helps DVC analyze whether any dependencies have changed and thus executing stages required to regenerate @@ -241,11 +242,11 @@ data science experiments. - `-v`, `--verbose` - displays detailed tracing information. -[visualizing plots]: /doc/user-guide/visualizing-plots +[visualizing plots]: /doc/user-guide/experiment-management/visualizing-plots [details]: /doc/user-guide/project-structure/internal-files#run-cache [not recommended]: /doc/user-guide/project-structure/dvcyaml-files#avoiding-unexpected-behavior -[managing external data]: /doc/user-guide/managing-external-data +[managing external data]: /doc/user-guide/data-management/managing-external-data ## Examples diff --git a/content/docs/command-reference/stage/add.md b/content/docs/command-reference/stage/add.md index b2c468c279..25b25bb168 100644 --- a/content/docs/command-reference/stage/add.md +++ b/content/docs/command-reference/stage/add.md @@ -91,9 +91,10 @@ Relevant notes: [Structure of cache directory](/doc/user-guide/project-structure/internal-files#structure-of-the-cache-directory) for more info.) -- [external dependencies](/doc/user-guide/external-dependencies) and - [external outputs](/doc/user-guide/managing-external-data) (outside of the - workspace) are also supported (except metrics and plots). +- [external dependencies](/doc/user-guide/data-management/importing-external-data) + and [external outputs](/doc/user-guide/data-management/managing-external-data) + (outside of the workspace) are also supported (except metrics and + plots). - Outputs are deleted from the workspace before executing the command (including at `dvc repro`) if their paths are found as existing files/directories (unless @@ -139,7 +140,7 @@ data science experiments. on. Multiple dependencies can be specified like this: `-d data.csv -d process.py`. Usually, each dependency is a file or a directory with data, or a code file, or a configuration file. DVC also supports certain - [external dependencies](/doc/user-guide/external-dependencies). + [external dependencies](/doc/user-guide/data-management/importing-external-data). When you use `dvc repro`, the list of dependencies helps DVC analyze whether any dependencies have changed and thus executing stages required to regenerate @@ -216,7 +217,7 @@ data science experiments. when reproducing the pipeline. - `--external` - allow writing outputs outside of the DVC repository. See - [Managing External Data](/doc/user-guide/managing-external-data). + [Managing External Data](/doc/user-guide/data-management/managing-external-data). - `--desc ` - user description of the stage (optional). This doesn't affect any DVC operations. @@ -228,7 +229,7 @@ data science experiments. - `-v`, `--verbose` - displays detailed tracing information. -[visualizing plots]: /doc/user-guide/visualizing-plots +[visualizing plots]: /doc/user-guide/experiment-management/visualizing-plots ## Examples diff --git a/content/docs/command-reference/version.md b/content/docs/command-reference/version.md index ca0b008c99..36fcc7dfb3 100644 --- a/content/docs/command-reference/version.md +++ b/content/docs/command-reference/version.md @@ -12,17 +12,17 @@ usage: dvc version [-h] [-q | -v] `dvc version` outputs the following information about the system/environment: -| Line | Detail | -| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`DVC version`](#components-of-dvc-version) | Version of DVC, and name of the binary or package manager (`pip`, `conda`, etc.) used to install DVC (along with a Git commit hash in case of a development version) | -| `Platform` | Version of Python in the environment where DVC is initialized, and information about the operating system | -| `Supports` | Types of [remote storage](/doc/command-reference/remote/add#supported-storage-types) supported by the current DVC setup (their required dependencies are installed) | -| `Cache types` | [Types of links](/doc/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache) supported (between workspace and cache) | -| `Cache directory` | Filesystem type (e.g. ext4, FAT, etc.) and drive on which the cache directory is mounted | -| `Caches` | Cache [location types](/doc/user-guide/managing-external-data) configured in the repo (e.g. local, SSH, S3, etc.) | -| `Remotes` | Remote [location types](/doc/command-reference/remote/add#supported-storage-types) configured in the repo (e.g. SSH, S3, Google Drive, etc.) | -| `Workspace directory` | Filesystem type (e.g. ext4, FAT, etc.) and drive on which the workspace is mounted | -| `Repo` | Shows whether we are in a DVC repo and/or Git repo | +| Line | Detail | +| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`DVC version`](#components-of-dvc-version) | Version of DVC, and name of the binary or package manager (`pip`, `conda`, etc.) used to install DVC (along with a Git commit hash in case of a development version) | +| `Platform` | Version of Python in the environment where DVC is initialized, and information about the operating system | +| `Supports` | Types of [remote storage](/doc/command-reference/remote/add#supported-storage-types) supported by the current DVC setup (their required dependencies are installed) | +| `Cache types` | [Types of links](/doc/user-guide/data-management/large-dataset-optimization#file-link-types-for-the-dvc-cache) supported (between workspace and cache) | +| `Cache directory` | Filesystem type (e.g. ext4, FAT, etc.) and drive on which the cache directory is mounted | +| `Caches` | Cache [location types](/doc/user-guide/data-management/managing-external-data) configured in the repo (e.g. local, SSH, S3, etc.) | +| `Remotes` | Remote [location types](/doc/command-reference/remote/add#supported-storage-types) configured in the repo (e.g. SSH, S3, Google Drive, etc.) | +| `Workspace directory` | Filesystem type (e.g. ext4, FAT, etc.) and drive on which the workspace is mounted | +| `Repo` | Shows whether we are in a DVC repo and/or Git repo | > No info about `Cache` or `Workspace directory` is printed if `dvc version` is > used outside a DVC project. diff --git a/content/docs/dvclive/api-reference/live/log_plot.md b/content/docs/dvclive/api-reference/live/log_plot.md index 0c7bb9bc0e..2e2fa75616 100644 --- a/content/docs/dvclive/api-reference/live/log_plot.md +++ b/content/docs/dvclive/api-reference/live/log_plot.md @@ -93,8 +93,8 @@ plot. Stores the labels and predictions in `{Live.dir}/plots/confusion_matrix.json`, with the format expected by the confusion matrix -[template](/doc/user-guide/visualizing-plots#plot-templates-data-series-only) of -`dvc plots`. +[template](/doc/user-guide/experiment-management/visualizing-plots#plot-templates-data-series-only) +of `dvc plots`. ```py y_true = [1, 1, 2, 2] diff --git a/content/docs/install/windows.md b/content/docs/install/windows.md index 66850560c9..d2df49080f 100644 --- a/content/docs/install/windows.md +++ b/content/docs/install/windows.md @@ -1,8 +1,8 @@ # Installation on Windows > 💡 Please review -> [Running DVC on Windows](/doc/user-guide/running-dvc-on-windows) for important -> tips to improve your experience using DVC on Windows. +> [Running DVC on Windows](/doc/user-guide/how-to/run-dvc-on-windows) for +> important tips to improve your experience using DVC on Windows. > To use DVC [as a Python library](/doc/api-reference), please > [install with pip](#install-with-pip) or [with conda](#install-with-conda). @@ -51,7 +51,7 @@ In this case it installs the `boto3` library along with DVC. ## Install with pip From Command Prompt or other -[recommended consoles](/doc/user-guide/running-dvc-on-windows): +[recommended consoles](/doc/user-guide/how-to/run-dvc-on-windows): ```dvc $ pip install dvc @@ -86,4 +86,5 @@ DVC. You may use Windows Uninstaller to > Note that this method by default enables symlink permissions for all users, so > they can use them to -> [optimize DVC](/doc/user-guide/large-dataset-optimization) operations. +> [optimize DVC](/doc/user-guide/data-management/large-dataset-optimization) +> operations. diff --git a/content/docs/sidebar.json b/content/docs/sidebar.json index d84001da2a..30059def05 100644 --- a/content/docs/sidebar.json +++ b/content/docs/sidebar.json @@ -154,7 +154,7 @@ "slug": "how-to", "source": false, "children": [ - "running-dvc-on-windows", + "run-dvc-on-windows", "setup-google-drive-remote", "stop-tracking-data", "update-tracked-data", diff --git a/content/docs/start/data-management/data-versioning.md b/content/docs/start/data-management/data-versioning.md index ee503e9d05..bee2486bf9 100644 --- a/content/docs/start/data-management/data-versioning.md +++ b/content/docs/start/data-management/data-versioning.md @@ -299,5 +299,5 @@ You can learn more about advanced workflows using these links: store, version and access a lot of data on a large shared volume efficiently. - A quite advanced scenario is to track and version data directly on the remote storage (e.g. S3). See - [Managing External Data](https://dvc.org/doc/user-guide/managing-external-data) + [Managing External Data](https://dvc.org/doc/user-guide/data-management/managing-external-data) to learn more. diff --git a/content/docs/start/experiment-management/visualization.md b/content/docs/start/experiment-management/visualization.md index 730b1d1925..53f8059d24 100644 --- a/content/docs/start/experiment-management/visualization.md +++ b/content/docs/start/experiment-management/visualization.md @@ -114,5 +114,5 @@ workflow: - [DVCLive] integrations can produce plots automatically during training. -[plot outputs]: /doc/user-guide/visualizing-plots +[plot outputs]: /doc/user-guide/experiment-management/visualizing-plots [dvclive]: /doc/dvclive/dvclive-with-dvc diff --git a/content/docs/use-cases/fast-data-caching-hub.md b/content/docs/use-cases/fast-data-caching-hub.md index 70d9c0cda7..1bb99685c3 100644 --- a/content/docs/use-cases/fast-data-caching-hub.md +++ b/content/docs/use-cases/fast-data-caching-hub.md @@ -30,10 +30,10 @@ to You can have a single storage for all you projects by setting up a [shared DVC cache] in a near location (network, external drive, etc.). This de-duplicates files across datasets and prevents repetitive transfers by -[linking](/doc/user-guide/large-dataset-optimization) your working files and -directories. Data security policies can be implemented reliably, as data never -leaves the central storage. DVC can also help you back up and [share data and ML -models] on external/remote locations. +[linking](/doc/user-guide/data-management/large-dataset-optimization) your +working files and directories. Data security policies can be implemented +reliably, as data never leaves the central storage. DVC can also help you back +up and [share data and ML models] on external/remote locations. Now that your team shares a primary storage, it can be managed independently as part of your infrastructure; provisioned depending on data access speed and cost diff --git a/content/docs/use-cases/versioning-data-and-models/index.md b/content/docs/use-cases/versioning-data-and-models/index.md index adb976e561..aadd57a138 100644 --- a/content/docs/use-cases/versioning-data-and-models/index.md +++ b/content/docs/use-cases/versioning-data-and-models/index.md @@ -39,7 +39,7 @@ As you use DVC, unique versions of your data files and directories are in a systematic way (preventing file duplication). The working datastore is separated from your workspace to keep the project light, but stays connected via file -[links](/doc/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache) +[links](/doc/user-guide/data-management/large-dataset-optimization#file-link-types-for-the-dvc-cache) handled automatically by DVC. Benefits of our approach include: @@ -59,8 +59,8 @@ Benefits of our approach include: [etc.](/doc/command-reference/remote/add#supported-storage-types)) — free from Git hosting [constraints](https://docs.github.com/en/free-pro-team@latest/github/managing-large-files/what-is-my-disk-quota). - DVC [optimizes](/doc/user-guide/large-dataset-optimization) storing and - transferring large files. + DVC [optimizes](/doc/user-guide/data-management/large-dataset-optimization) + storing and transferring large files. - **Collaboration**: Easily distribute your project development and share its data [internally](/doc/user-guide/how-to/share-a-dvc-cache) and diff --git a/content/docs/use-cases/versioning-data-and-models/tutorial.md b/content/docs/use-cases/versioning-data-and-models/tutorial.md index ec8dbdde48..1f40ce44be 100644 --- a/content/docs/use-cases/versioning-data-and-models/tutorial.md +++ b/content/docs/use-cases/versioning-data-and-models/tutorial.md @@ -40,8 +40,8 @@ Also, if DVC is not installed, please follow these [instructions](/doc/install) to do so. > If you're using Windows, please review -> [Running DVC on Windows](/doc/user-guide/running-dvc-on-windows) for important -> tips to improve your experience. +> [Running DVC on Windows](/doc/user-guide/how-to/run-dvc-on-windows) for +> important tips to improve your experience. Okay! Let's first download the code and set up a Git repository: @@ -132,7 +132,7 @@ You can use this command instead of `git add` on files or directories that are too large to be tracked with Git: usually input datasets, models, some intermediate results, etc. It tells Git to ignore the directory and puts it into the cache (while keeping a -[file link](/doc/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache) +[file link](/doc/user-guide/data-management/large-dataset-optimization#file-link-types-for-the-dvc-cache) to it in the workspace, so you can continue working the same way as before). This is achieved by creating a tiny, human-readable `.dvc` file that serves as a pointer to the cache. diff --git a/content/docs/user-guide/basic-concepts/external-dependency.md b/content/docs/user-guide/basic-concepts/external-dependency.md index 084fe9abb0..285fec069a 100644 --- a/content/docs/user-guide/basic-concepts/external-dependency.md +++ b/content/docs/user-guide/basic-concepts/external-dependency.md @@ -6,5 +6,5 @@ tooltip: >- stage](/doc/command-reference/import) `.dvc` file) with origin in an external source, for example HTTP, SSH, Amazon S3, Google Cloud Storage remote locations, or even other DVC repositories. See [External - Dependencies](/doc/user-guide/external-dependencies). + Dependencies](/doc/user-guide/data-management/importing-external-data). --- diff --git a/content/docs/user-guide/basic-concepts/file-link.md b/content/docs/user-guide/basic-concepts/file-link.md index 17f48ea150..9c3b37116a 100644 --- a/content/docs/user-guide/basic-concepts/file-link.md +++ b/content/docs/user-guide/basic-concepts/file-link.md @@ -4,6 +4,7 @@ match: [linked] tooltip: >- A way to have a file appear in multiple different folders without occupying more physical space on the storage disk. This is both fast and economical. See - [large dataset optimization](/doc/user-guide/large-dataset-optimization) and + [large dataset + optimization](/doc/user-guide/data-management/large-dataset-optimization) and `dvc config cache` for more on file linking. --- diff --git a/content/docs/user-guide/data-management/importing-external-data.md b/content/docs/user-guide/data-management/importing-external-data.md index e2e94bb3eb..53d22ad344 100644 --- a/content/docs/user-guide/data-management/importing-external-data.md +++ b/content/docs/user-guide/data-management/importing-external-data.md @@ -7,8 +7,8 @@ running [Dask](https://dask.org/) via SSH, or for a script that streams data from S3 to process it. _External dependencies_ and -[external outputs](/doc/user-guide/managing-external-data) provide ways to track -and version data outside of the project. +[external outputs](/doc/user-guide/data-management/managing-external-data) +provide ways to track and version data outside of the project. ## How external dependencies work diff --git a/content/docs/user-guide/data-management/managing-external-data.md b/content/docs/user-guide/data-management/managing-external-data.md index 780fb8190c..8a0b1a7b06 100644 --- a/content/docs/user-guide/data-management/managing-external-data.md +++ b/content/docs/user-guide/data-management/managing-external-data.md @@ -17,8 +17,8 @@ HDFS, running [Dask](https://dask.org/) via SSH, or any code that generates massive files directly to the cloud. _External outputs_ (and -[external dependencies](/doc/user-guide/external-dependencies)) provide ways to -track and version data outside of the project. +[external dependencies](/doc/user-guide/data-management/importing-external-data)) +provide ways to track and version data outside of the project. ## How external outputs work @@ -50,7 +50,7 @@ avoids transferring files to the local environment and enables [file links] within the external storage. [file links]: - /doc/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache + /doc/user-guide/data-management/large-dataset-optimization#file-link-types-for-the-dvc-cache As an example, let's create a directory external to the workspace and set it up as cache: diff --git a/content/docs/user-guide/experiment-management/visualizing-plots.md b/content/docs/user-guide/experiment-management/visualizing-plots.md index 1a7d9c7b30..34a3bb7fca 100644 --- a/content/docs/user-guide/experiment-management/visualizing-plots.md +++ b/content/docs/user-guide/experiment-management/visualizing-plots.md @@ -298,11 +298,14 @@ template from pre-defined ones. ## Comparing plots When you run [experiments] or otherwise update the data in the plots files, -those updates will be automatically reflected in your visualizations. To compare -between experiments or Git [revisions], you can use `dvc plots diff` or the -[plots dashboard] from the [VS Code Extension][dvc extension]. +those updates will be automatically reflected in your visualizations. To +[compare between experiments] or Git [revisions], you can use `dvc plots diff`, +`dvc exp show --pcp`, or the [plots dashboard] from the [VS Code +Extension][dvc extension]. ![](/img/plots_compare_vs_code.png) [experiments]: /doc/user-guide/experiment-management/experiments-overview +[compare between experiments]: + /doc/user-guide/experiment-management/comparing-experiments [revisions]: https://git-scm.com/docs/revisions diff --git a/content/docs/user-guide/how-to/running-dvc-on-windows.md b/content/docs/user-guide/how-to/run-dvc-on-windows.md similarity index 88% rename from content/docs/user-guide/how-to/running-dvc-on-windows.md rename to content/docs/user-guide/how-to/run-dvc-on-windows.md index debb93b74d..1d69508c2c 100644 --- a/content/docs/user-guide/how-to/running-dvc-on-windows.md +++ b/content/docs/user-guide/how-to/run-dvc-on-windows.md @@ -1,11 +1,17 @@ -# Running DVC on Windows +--- +title: 'How to Run DVC on Windows' +description: >- + Learn to setup your Windows environment for an optimal experience using DVC. +--- + +# How to Run DVC on Windows Different issues can arise when running DVC on Microsoft Windows, mainly involving system performance. Some, for example, have to do with NTFS file system characteristics and Windows built-in security mechanisms. Below are some workarounds that can help avoid these potential problems: - + Did you know that DVC is available for Microsoft **Visual Studio Code**? More details [here](/doc/install/ide-plugins#visual-studio-code)! @@ -37,11 +43,11 @@ perfect solution, but here are some ideas: ## Enable symbolic links Symlinks are one of the possible file link types that DVC can use for -[optimization](/doc/user-guide/large-dataset-optimization) purposes. They're -available on Windows, but the _Create symbolic links_ user privilege is needed. -It's granted to the _Administrators_ group by default, so running `dvc` in an -admin terminal is a good option for occasional usage. For regular users, it can -be granted using the Local policy settings. +[optimization](/doc/user-guide/data-management/large-dataset-optimization) +purposes. They're available on Windows, but the _Create symbolic links_ user +privilege is needed. It's granted to the _Administrators_ group by default, so +running `dvc` in an admin terminal is a good option for occasional usage. For +regular users, it can be granted using the Local policy settings. This is done automatically by DVC's [Windows installer](/doc/install/windows), but you may want to diff --git a/content/docs/user-guide/how-to/setup-google-drive-remote.md b/content/docs/user-guide/how-to/setup-google-drive-remote.md index 064707529f..9f0c3c186c 100644 --- a/content/docs/user-guide/how-to/setup-google-drive-remote.md +++ b/content/docs/user-guide/how-to/setup-google-drive-remote.md @@ -1,4 +1,11 @@ -# Setup a Google Drive DVC Remote +--- +title: 'How to Setup a Google Drive DVC Remote' +description: >- + We explain the existing ways to setup Google Drive remote storage for your DVC + projects. +--- + +# How to Setup a Google Drive DVC Remote In this guide we explain the existing ways to setup Google Drive [remote storage](/doc/command-reference/remote) for your DVC @@ -241,7 +248,7 @@ running inside a Compute Engine, automatic CI/CD, etc. No interactive user OAuth authentication is needed. > This requires having your own -> [GC project](/doc/user-guide/setup-google-drive-remote#using-a-custom-google-cloud-project-recommended) +> [GC project](/doc/user-guide/how-to/setup-google-drive-remote#using-a-custom-google-cloud-project-recommended) > as explained above. 1. To diff --git a/content/docs/user-guide/how-to/share-a-dvc-cache.md b/content/docs/user-guide/how-to/share-a-dvc-cache.md index d98ce015e4..d83b7f7c11 100644 --- a/content/docs/user-guide/how-to/share-a-dvc-cache.md +++ b/content/docs/user-guide/how-to/share-a-dvc-cache.md @@ -59,7 +59,7 @@ $ sudo chown -R myuser:ourgroup /home/shared/dvc-cache/ ## Configure the shared cache A cache directory outside the workspace is called an -[external cache](/doc/user-guide/managing-external-data#setting-up-an-external-cache). +[external cache](/doc/user-guide/data-management/managing-external-data#setting-up-an-external-cache). Set it to the directory we created earlier with `dvc cache dir` and configure it with `dvc config cache`: @@ -75,7 +75,8 @@ enable symlinks to avoid having copies from the external cache to the workspace. > See `dvc config cache` and -> [File link types](/doc/user-guide/large-dataset-optimization) for more info. +> [File link types](/doc/user-guide/data-management/large-dataset-optimization) +> for more info. diff --git a/content/docs/user-guide/how-to/update-tracked-data.md b/content/docs/user-guide/how-to/update-tracked-data.md index beb85489c3..4cf32bac56 100644 --- a/content/docs/user-guide/how-to/update-tracked-data.md +++ b/content/docs/user-guide/how-to/update-tracked-data.md @@ -17,8 +17,8 @@ default, see `dvc config cache` for more info.), updating tracked files has to be carried out with caution, to avoid data corruption. This is due to the way in which DVC handles linking data files between the cache and the workspace (refer to -[Large Dataset Optimization](/doc/user-guide/large-dataset-optimization) for -details). +[Large Dataset Optimization](/doc/user-guide/data-management/large-dataset-optimization) +for details). If you use `dvc.yaml` files and `dvc repro`, there is no need to manage stage outputs manually. DVC removes them for you before regenerating diff --git a/content/docs/user-guide/pipelines/defining-pipelines.md b/content/docs/user-guide/pipelines/defining-pipelines.md index b3fe5867c7..790acfb306 100644 --- a/content/docs/user-guide/pipelines/defining-pipelines.md +++ b/content/docs/user-guide/pipelines/defining-pipelines.md @@ -42,7 +42,7 @@ files to find stages, rebuilding all the pipelines that these may define. [data versioning]: /doc/start/data-management/data-versioning [metrics]: /doc/command-reference/metrics -[plots]: /doc/user-guide/visualizing-plots +[plots]: /doc/user-guide/experiment-management/visualizing-plots
@@ -172,7 +172,7 @@ A less common kind of dependency is a _URL dependency_. Instead of files in a local disk, you can `dvc import` data from another DVC project (for example hosted on GitHub). External dependencies establish relationships between different projects or systems (see `dvc import-url`). -[Get all the details](/doc/user-guide/external-dependencies). +[Get all the details](/doc/user-guide/data-management/importing-external-data). diff --git a/content/docs/user-guide/privacy.md b/content/docs/user-guide/privacy.md index 040e3182c1..89393d4e4e 100644 --- a/content/docs/user-guide/privacy.md +++ b/content/docs/user-guide/privacy.md @@ -3,7 +3,7 @@ DVC is using the [Google Drive API](https://developers.google.com/drive/) to make it easier to store files on Google Drive. For more details on how to set it up, refer to -[Setup a Google Drive DVC Remote](/doc/user-guide/setup-google-drive-remote). +[Setup a Google Drive DVC Remote](/doc/user-guide/how-to/setup-google-drive-remote). DVC uses the _DVC_ Application on Google Cloud Platform. (That is the name you will see in a consent screen.) This integration is governed by common policies, @@ -42,8 +42,8 @@ authorized e.g. it will name the target API(s) and whether you are authorizing There are two ways to use DVC with Google Drive without authorizing the _DVC_ Application: bring your own service account token or configure the package to use an OAuth client of your choice. See -[Setup a Google Drive DVC Remote](/doc/user-guide/setup-google-drive-remote) for -more information. +[Setup a Google Drive DVC Remote](/doc/user-guide/how-to/setup-google-drive-remote) +for more information. ## Scopes diff --git a/content/docs/user-guide/project-structure/dvc-files.md b/content/docs/user-guide/project-structure/dvc-files.md index 9713d657db..c67da0009c 100644 --- a/content/docs/user-guide/project-structure/dvc-files.md +++ b/content/docs/user-guide/project-structure/dvc-files.md @@ -9,8 +9,9 @@ locally. See [Data Versioning] for more info. -\* Certain [external locations](/doc/user-guide/managing-external-data) are also -supported. +\* Certain +[external locations](/doc/user-guide/data-management/managing-external-data) are +also supported. @@ -61,20 +62,20 @@ Comments can be entered using the `# comment` format. The following subfields may be present under `outs` entries: -| Field | Description | -| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `path` | (Required) Path to the file or directory (relative to `wdir` which defaults to the file's location) | -| `md5`
`etag`
`checksum` | Hash value for the file or directory being tracked with DVC. MD5 is used for most locations (local file system and SSH); [ETag](https://en.wikipedia.org/wiki/HTTP_ETag#Strong_and_weak_validation) for HTTP, S3, or Azure [external outputs](/doc/user-guide/managing-external-data); and a special _checksum_ for HDFS and WebHDFS. | -| `size` | Size of the file or directory (sum of all files) | -| `nfiles` | If this output is a directory, the number of files inside (recursive). | -| `isexec` | Whether this is an executable file. DVC preserves execute permissions upon `dvc checkout` and `dvc pull`. This has no effect on directories, or in general on Windows. | -| `cache` | Whether or not this file or directory is cached (`true` by default). See the `--no-commit` option of `dvc add`. | -| `remote` | Name of the remote to use for pushing/fetching | -| `persist` | Whether the output file/dir should remain in place while `dvc repro` runs (`false` by default: outputs are deleted when `dvc repro` starts) | -| `desc` | User description for this output (supported in metrics and plots too). This doesn't affect any DVC operations. | -| `type` | User-assigned type of the data. | -| `labels` | User-assigned labels to add to the data. | -| `meta` | Custom metadata about the data. | +| Field | Description | +| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `path` | (Required) Path to the file or directory (relative to `wdir` which defaults to the file's location) | +| `md5`
`etag`
`checksum` | Hash value for the file or directory being tracked with DVC. MD5 is used for most locations (local file system and SSH); [ETag](https://en.wikipedia.org/wiki/HTTP_ETag#Strong_and_weak_validation) for HTTP, S3, or Azure [external outputs](/doc/user-guide/data-management/managing-external-data); and a special _checksum_ for HDFS and WebHDFS. | +| `size` | Size of the file or directory (sum of all files) | +| `nfiles` | If this output is a directory, the number of files inside (recursive). | +| `isexec` | Whether this is an executable file. DVC preserves execute permissions upon `dvc checkout` and `dvc pull`. This has no effect on directories, or in general on Windows. | +| `cache` | Whether or not this file or directory is cached (`true` by default). See the `--no-commit` option of `dvc add`. | +| `remote` | Name of the remote to use for pushing/fetching | +| `persist` | Whether the output file/dir should remain in place while `dvc repro` runs (`false` by default: outputs are deleted when `dvc repro` starts) | +| `desc` | User description for this output (supported in metrics and plots too). This doesn't affect any DVC operations. | +| `type` | User-assigned type of the data. | +| `labels` | User-assigned labels to add to the data. | +| `meta` | Custom metadata about the data. | ## Dependency entries diff --git a/content/docs/user-guide/project-structure/dvcyaml-files.md b/content/docs/user-guide/project-structure/dvcyaml-files.md index bdd1ffa5bc..d6c81cc7de 100644 --- a/content/docs/user-guide/project-structure/dvcyaml-files.md +++ b/content/docs/user-guide/project-structure/dvcyaml-files.md @@ -600,7 +600,8 @@ Optional configuration fields can be provided as well. Refer to [Visualizing Plots] and `dvc plots show` for examples. -[visualizing plots]: /doc/user-guide/visualizing-plots#top-level-plots +[visualizing plots]: + /doc/user-guide/experiment-management/visualizing-plots#top-level-plots @@ -632,7 +633,7 @@ Refer to [Visualizing Plots] and `dvc plots show` for examples. - `template` (string) - [plot template]. Defaults to `linear`. [plot template]: - https://dvc.org/doc/user-guide/visualizing-plots#plot-templates-data-series-only + https://dvc.org/doc/user-guide/experiment-management/visualizing-plots#plot-templates-data-series-only ## dvc.lock file diff --git a/content/docs/user-guide/project-structure/internal-files.md b/content/docs/user-guide/project-structure/internal-files.md index f3f2776a83..05d25d2f0e 100644 --- a/content/docs/user-guide/project-structure/internal-files.md +++ b/content/docs/user-guide/project-structure/internal-files.md @@ -20,9 +20,9 @@ operation. [structure](#structure-of-the-cache-directory). The data files and directories in the workspace will only contain links to the data files in the cache (refer to - [Large Dataset Optimization](/doc/user-guide/large-dataset-optimization). See - `dvc config cache` for related configuration options, including changing its - location. + [Large Dataset Optimization](/doc/user-guide/data-management/large-dataset-optimization). + See `dvc config cache` for related configuration options, including changing + its location. > Note that DVC includes the cache directory in `.gitignore` during > initialization. No data tracked by DVC should ever be pushed to the Git @@ -32,7 +32,7 @@ operation. - `.dvc/cache/runs`: Default location of the [run-cache](#run-cache). - `.dvc/plots`: Directory for - [plot templates](/doc/user-guide/visualizing-plots#plot-templates-data-series-only) + [plot templates](/doc/user-guide/experiment-management/visualizing-plots#plot-templates-data-series-only) - `.dvc/tmp`: Directory for miscellaneous temporary files diff --git a/content/docs/user-guide/troubleshooting.md b/content/docs/user-guide/troubleshooting.md index 897ab9ae13..d4d30daacb 100644 --- a/content/docs/user-guide/troubleshooting.md +++ b/content/docs/user-guide/troubleshooting.md @@ -79,10 +79,10 @@ fail. ## No possible cache types {#cache-types} You may encounter this error if DVC cannot find a valid -[file link type](/doc/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache) +[file link type](/doc/user-guide/data-management/large-dataset-optimization#file-link-types-for-the-dvc-cache) to use when linking data files from cache into your workspace. To resolve the issue, you may need to -[reconfigure](/doc/user-guide/large-dataset-optimization#configuring-dvc-cache-file-link-type) +[reconfigure](/doc/user-guide/data-management/large-dataset-optimization#configuring-dvc-cache-file-link-type) DVC to use alternative link types which are supported on your machine. After reconfiguring cache types, you can re-link data files in your workspace diff --git a/redirects-list.json b/redirects-list.json index c503c75bf7..aaa057b32e 100644 --- a/redirects-list.json +++ b/redirects-list.json @@ -76,7 +76,7 @@ "^/doc/user-guide/large-dataset-optimization$ /doc/user-guide/data-management/large-dataset-optimization 302", "^/doc/user-guide/external-dependencies$ /doc/user-guide/data-management/importing-external-data 302", "^/doc/user-guide/managing-external-data$ /doc/user-guide/data-management/managing-external-data 302", - "^/doc/user-guide/running-dvc-on-windows$ /doc/user-guide/how-to/running-dvc-on-windows 302", + "^/doc/user-guide/running-dvc-on-windows$ /doc/user-guide/how-to/run-dvc-on-windows 302", "^/doc/user-guide/setup-google-drive-remote$ /doc/user-guide/how-to/setup-google-drive-remote 302", "^/doc/user-guide/visualizing-plots$ /doc/user-guide/experiment-management/visualizing-plots 302", "^/doc/understanding-dvc(/.*)?$ /doc/user-guide/what-is-dvc",