diff --git a/content/docs/user-guide/project-structure/dvcyaml-files.md b/content/docs/user-guide/project-structure/dvcyaml-files.md index 20880c399d..dddb6b351f 100644 --- a/content/docs/user-guide/project-structure/dvcyaml-files.md +++ b/content/docs/user-guide/project-structure/dvcyaml-files.md @@ -16,10 +16,6 @@ with Git along with other DVC files and your project's code. ## Artifacts This section allows you to declare structured metadata about your artifacts. -Although you can specify artifacts of any `type`, DVC-based -[model registry](/doc/use-cases/model-registry) will pick up any artifacts with -type `model`. Additionally, they will be available in -[Studio Model Registry](/doc/studio/user-guide/model-registry/what-is-a-model-registry). ```yaml artifacts: @@ -34,6 +30,20 @@ artifacts: framework: pytorch ``` +For every artifact ID you can specify the following elements (only `path` is +mandatory): + +- `path` (_string_) - The path to the artifact, either relative to the root of + the repository or a full path in an external storage such as S3. +- `type` (_string_) - You can specify artifacts of any `type` and the DVC-based + [model registry](/doc/studio/user-guide/model-registry/what-is-a-model-registry) + will pick up any artifacts with type `model`. +- `desc` (_string_) - A description of your artifact +- `labels` (_list_) - Any labels you want to add to the artifact +- `meta` - Any extra extra information, the content of this element will be + ignored by DVC and will not show up in the + [model registry](/doc/studio/user-guide/model-registry/what-is-a-model-registry) + Artifact IDs must consist of letters and numbers, and use '-' as separator (but not at the start or end).