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

# Registry

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/apis/public/registries/registry.py" />

## <kbd>class</kbd> `Registry`

A single registry in the Registry.

### <kbd>method</kbd> `Registry.__init__`

```python theme={null}
__init__(
    client: 'Client',
    organization: 'str',
    entity: 'str',
    name: 'str',
    attrs: 'dict[str, Any] | None' = None
)
```

***

### <kbd>property</kbd> Registry.allow\_all\_artifact\_types

Returns whether all artifact types are allowed in the registry.

If `True` then artifacts of any type can be added to this registry. If `False` then artifacts are restricted to the types in `artifact_types` for this registry.

***

### <kbd>property</kbd> Registry.artifact\_types

Returns the artifact types allowed in the registry.

If `allow_all_artifact_types` is `True` then `artifact_types` reflects the types previously saved or currently used in the registry. If `allow_all_artifact_types` is `False` then artifacts are restricted to the types in `artifact_types`.

**Note:**

> Previously saved artifact types cannot be removed.

**Example:**

```python theme={null}
import wandb

registry = wandb.Api().create_registry()
registry.artifact_types.append("model")
registry.save()  # once saved, the artifact type `model` cannot be removed
registry.artifact_types.append("accidentally_added")
registry.artifact_types.remove(
    "accidentally_added"
)  # Types can only be removed if it has not been saved yet
```

**Returns:**

* `AddOnlyArtifactTypesList`: The artifact\_types property value.

***

### <kbd>property</kbd> Registry.created\_at

Timestamp of when the registry was created.

**Returns:**

* `str`: The created\_at property value.

***

### <kbd>property</kbd> Registry.description

Description of the registry.

**Returns:**

* `str`: The description property value.

***

### <kbd>property</kbd> Registry.entity

Organization entity of the registry.

**Returns:**

* `str`: The entity property value.

***

### <kbd>property</kbd> Registry.full\_name

Full name of the registry including the `wandb-registry-` prefix.

**Returns:**

* `str`: The full\_name property value.

***

### <kbd>property</kbd> Registry.name

Name of the registry without the `wandb-registry-` prefix.

**Returns:**

* `str`: The name property value.

***

### <kbd>property</kbd> Registry.organization

Organization name of the registry.

**Returns:**

* `str`: The organization property value.

***

### <kbd>property</kbd> Registry.path

***

### <kbd>property</kbd> Registry.updated\_at

Timestamp of when the registry was last updated.

**Returns:**

* `str`: The updated\_at property value.

***

### <kbd>property</kbd> Registry.visibility

Visibility of the registry.

**Returns:**

* `Literal["organization", "restricted"]`:  The visibility level.
  * "organization": Anyone in the organization can view this registry.  You can edit their roles later from the settings in the UI.
  * "restricted": Only invited members via the UI can access this registry.  Public sharing is disabled.

**Returns:**

* `Literal['organization', 'restricted']`: The visibility property value.

***

### <kbd>method</kbd> `Registry.collections`

```python theme={null}
collections(filter: 'dict[str, Any] | None' = None) → Collections
```

Returns the collections belonging to the registry.

***

### <kbd>classmethod</kbd> `Registry.create`

```python theme={null}
create(
    client: 'Client',
    organization: 'str',
    name: 'str',
    visibility: "Literal['organization', 'restricted']",
    description: 'str | None' = None,
    artifact_types: 'list[str] | None' = None
)
```

Create a new registry.

The registry name must be unique within the organization. This function should be called using `api.create_registry()`

**Args:**

* `client`:  The GraphQL client.
* `organization`:  The name of the organization.
* `name`:  The name of the registry (without the `wandb-registry-` prefix).
* `visibility`:  The visibility level ('organization' or 'restricted').
* `description`:  An optional description for the registry.
* `artifact_types`:  An optional list of allowed artifact types.

**Returns:**

* `Registry`:  The newly created Registry object.

**Raises:**

* `ValueError`:  If a registry with the same name already exists in the  organization or if the creation fails.

***

### <kbd>method</kbd> `Registry.delete`

```python theme={null}
delete() → None
```

Delete the registry. This is irreversible.

***

### <kbd>method</kbd> `Registry.load`

```python theme={null}
load() → None
```

Load the registry attributes from the backend to reflect the latest saved state.

***

### <kbd>method</kbd> `Registry.save`

```python theme={null}
save() → None
```

Save registry attributes to the backend.

***

### <kbd>method</kbd> `Registry.versions`

```python theme={null}
versions(filter: 'dict[str, Any] | None' = None) → Versions
```

Returns the versions belonging to the registry.
