> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-ui-demoing.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

export const GitHubLink = ({url}) => <a href={url} target="_blank" rel="noopener noreferrer" className="github-source-link">
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0024 12c0-6.63-5.37-12-12-12z" />
    </svg>
    GitHub source
  </a>;

<GitHubLink url="https://github.com/wandb/wandb/blob/main/wandb/sdk/artifacts/artifact.py#L114" />

Flexible and lightweight building block for dataset and model versioning.

Construct an empty W\&B Artifact. Populate an artifacts contents with methods that
begin with `add`. Once the artifact has all the desired files, you can call
`run.log_artifact()` to log it.

## <kbd>class</kbd> Artifact

```python theme={null}
name: 'str',
type: 'str',
description: 'str | None' = None,
metadata: 'dict[str, Any] | None' = None,
incremental: 'bool' = False,
use_as: 'str | None' = None,
storage_region: 'str | None' = None
```

## Args

* `name`: A human-readable name for the artifact. Use the name to identify a specific artifact in the W\&B App UI or programmatically. You can interactively reference an artifact with the `use_artifact` Public API. A name can contain letters, numbers, underscores, hyphens, and dots. The name must be unique across a project.
* `type`: The artifact's type. Use the type of an artifact to both organize and differentiate artifacts. You can use any string that contains letters, numbers, underscores, hyphens, and dots. Common types include `dataset` or `model`. Include `model` within your type string if you want to link the artifact to the W\&B Model Registry. Note that some types reserved for internal use and cannot be set by users. Such types include `job` and types that start with `wandb-`.
* `description`: A description of the artifact. For Model or Dataset Artifacts, add documentation for your standardized team model or dataset card. View an artifact's description programmatically with the `Artifact.description` attribute or programmatically with the W\&B App UI. W\&B renders the description as markdown in the W\&B App.
* `metadata`: Additional information about an artifact. Specify metadata as a dictionary of key-value pairs. You can specify no more than 100 total keys.
* `incremental`: Use `Artifact.new_draft()` method instead to modify an existing artifact.
* `use_as`: Deprecated.
* `storage_region`:

## Members

### Methods

| Name                                                                | Summary                               |
| ------------------------------------------------------------------- | ------------------------------------- |
| [`add()`](/models/ref/python/experiments/artifact/artifact-add)     | Add object to artifact                |
| [`add_dir()`](/models/ref/python/experiments/artifact/artifact-dir) | Add a local directory to the artifact |

### Properties

| Name                                                                | Summary                               |
| ------------------------------------------------------------------- | ------------------------------------- |
| [`add()`](/models/ref/python/experiments/artifact/artifact-add)     | Add object to artifact                |
| [`add_dir()`](/models/ref/python/experiments/artifact/artifact-dir) | Add a local directory to the artifact |
