Registry

  2 minute read  

View the source code

A single registry in the Registry.

Registry(
    client: "Client",
    organization: str,
    entity: str,
    name: str,
    attrs: Optional[Dict[str, Any]] = None
)
Attributes
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.
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.
created_at Timestamp of when the registry was created.
description Description of the registry.
entity Organization entity of the registry.
full_name Full name of the registry including the wandb-registry- prefix.
name Name of the registry without the wandb-registry- prefix.
organization Organization name of the registry.
updated_at Timestamp of when the registry was last updated.
visibility Visibility of the registry.

Methods

collections

View source

collections(
    filter: Optional[Dict[str, Any]] = None
) -> Collections

Returns the collections belonging to the registry.

create

View source

@classmethod
create(
    client: "Client",
    organization: str,
    name: str,
    visibility: Literal['organization', 'restricted'],
    description: Optional[str] = None,
    artifact_types: Optional[List[str]] = 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.

delete

View source

delete() -> None

Delete the registry. This is irreversible.

load

View source

load() -> None

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

save

View source

save() -> None

Save registry attributes to the backend.

versions

View source

versions(
    filter: Optional[Dict[str, Any]] = None
) -> Versions

Returns the versions belonging to the registry.


Last modified May 12, 2025