Registry

Class wandb.apis.public.Registry

A single registry in the Registry.

(service_api: 'ServiceApi',
organization: 'str',
entity: 'str',
name: 'str',
attrs: 'RegistryFragment | None' = None)

Args

ServiceApi

No description provided.

str

No description provided.

str

No description provided.

str

No description provided.

RegistryFragment | None

No description provided.

Properties

bool

Return whether all artifact types are allowed in the registry.If True, artifacts of any type can be added. If False, artifacts are restricted to the types listed in artifact_types.

AddOnlyArtifactTypesList

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.

str

Timestamp of when the registry was created.

str | None

Description of the registry.

str

Organization entity of the registry.

str

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

str

The unique ID for this registry.

str | None

The GraphQL internalId for this registry’s backing project, if fetched.This is a base64-encoded global ID. When decoded, it looks like Project:123 or ProjectInternalId:123.

str

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

str

Organization name of the registry.

list[str]

No description provided.

str | None

Timestamp of when the registry was last updated.

The visibility level.

Visibility of the registry.

Methods

method Registry.add_members()

self, *members: 'User | UserMember | Team | TeamMember | str'

Adds users or teams to this registry.

Arguments

User | UserMember | Team | TeamMember | str

The users or teams to add to the registry. Accepts User objects, Team objects, or their string IDs.

Raises

TypeError: If no members are passed as arguments.
ValueError: If unable to infer or parse the user or team IDs.

Examples

import wandb

api = wandb.Api()

# Fetch an existing registry
registry = api.registry(name="my-registry", organization="my-org")

user1 = api.user(username="some-user")
user2 = api.user(username="other-user")
registry.add_members(user1, user2)

my_team = api.team(name="my-team")
registry.add_members(my_team)

method Registry.collections()

self,
filter: 'dict[str, Any] | None' = None,
order: 'str | None' = None,
per_page: 'PositiveInt' = 100,
start: 'str | None' = None

Returns the collections belonging to this registry.

Arguments

dict[str, Any] | None

Optional mapping of filters to apply to the collections query.

str | None

Optional string to specify the order of the results. If prefixed with ’+’, sorts ascending (default). If prefixed with ’-’, sorts descending.

PositiveInt

The number of results to fetch per page. Usually there is no reason to change this.

str | None

Pagination cursor for resuming a past query, captured from a previous paginator’s .cursor attribute.

method Registry.create()

api: 'Api',
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()

Arguments

Api

The W&B API instance.

str

The name of the organization.

str

The name of the registry (without the wandb-registry- prefix).

Literal['organization', 'restricted']

The visibility level (‘organization’ or ‘restricted’).

str | None

An optional description for the registry.

list[str] | None

An optional list of allowed artifact types.

Raises

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

method Registry.delete()

self

Delete the registry. This is irreversible.

method Registry.load()

self

Load registry attributes from the backend.

method Registry.members()

self

Returns the current members (users and teams) of this registry.

method Registry.remove_members()

self, *members: 'User | UserMember | Team | TeamMember | str'

Removes users or teams from this registry.

Arguments

User | UserMember | Team | TeamMember | str

The users or teams to remove from the registry. Accepts User objects, Team objects, or their string IDs.

Raises

TypeError: If no members are passed as arguments.
ValueError: If unable to infer or parse the user or team IDs.

Examples

import wandb

api = wandb.Api()

# Fetch an existing registry
registry = api.registry(name="my-registry", organization="my-org")

user1 = api.user(username="some-user")
user2 = api.user(username="other-user")
registry.remove_members(user1, user2)

old_team = api.team(name="old-team")
registry.remove_members(old_team)

method Registry.save()

self

Save registry attributes to the backend.

method Registry.team_members()

self

Returns the current member teams of this registry.

method Registry.update_member()

self,
member: 'User | UserMember | Team | TeamMember | str',
role: 'MemberRole | str'

Updates the role of a member (user or team) within this registry.

Arguments

User | UserMember | Team | TeamMember | str

The user or team to update the role of. Accepts a User object, Team object, or their string ID.

MemberRole | str

The new role to assign to the member. May be one of:

“admin”
“member”
“viewer”
“restricted_viewer” (if supported by the W&B server)

Raises

ValueError: If unable to infer the user or team ID.

Examples

Make all users in the registry admins

import wandb

api = wandb.Api()

# Fetch an existing registry
registry = api.registry(name="my-registry", organization="my-org")

for member in registry.user_members():
    registry.update_member(member.user, role="admin")

method Registry.user_members()

self

Returns the current member users of this registry.

method Registry.versions()

self,
filter: 'dict[str, Any] | None' = None,
order: '_VersionOrder | None' = None,
per_page: 'PositiveInt' = 100,
start: 'str | None' = None

Returns the artifact versions belonging to this registry.

Arguments

dict[str, Any] | None

Optional mapping of filters to apply to the artifact versions query.

_VersionOrder | None

Optional string to specify the order of the results. Order can be created_at, artifact_size, or linked_at. If prefixed with ’+’, sorts ascending (default). If prefixed with ’-’, sorts descending.

PositiveInt

The number of results to fetch per page. Usually there is no reason to change this.

str | None

Pagination cursor for resuming a past query, captured from a previous paginator’s .cursor attribute.

W&B Models

W&B Weave

Serverless Inference

Serverless Training

Class wandb.apis.public.Registry

Args

Properties

Methods

method Registry.add_members()

Arguments

Raises

Examples

method Registry.collections()

Arguments

method Registry.create()

Arguments

Raises

method Registry.delete()

method Registry.load()

method Registry.members()

method Registry.remove_members()

Arguments

Raises

Examples

method Registry.save()

method Registry.team_members()

method Registry.update_member()

Arguments

Raises

Examples

method Registry.user_members()

method Registry.versions()

Arguments

​Class wandb.apis.public.Registry

​Args

​Properties

​Methods

​method Registry.add_members()

Arguments

Raises

Examples

​method Registry.collections()

Arguments

​method Registry.create()

Arguments

Raises

​method Registry.delete()

​method Registry.load()

​method Registry.members()

​method Registry.remove_members()

Arguments

Raises

Examples

​method Registry.save()

​method Registry.team_members()

​method Registry.update_member()

Arguments

Raises

Examples

​method Registry.user_members()

​method Registry.versions()

Arguments

Class wandb.apis.public.Registry

Args

Properties

Methods

method Registry.add_members()

method Registry.collections()

method Registry.create()

method Registry.delete()

method Registry.load()

method Registry.members()

method Registry.remove_members()

method Registry.save()

method Registry.team_members()

method Registry.update_member()

method Registry.user_members()

method Registry.versions()