Registry methods

Class wandb.apis.public.Registry

method Registry.add_members()

Adds users or teams to this registry.

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

Arguments

User | UserMember | Team | TeamMember | str

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

Returns

This registry for further method chaining, if needed.

Raises

If no members are passed as arguments.

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()

Returns the collections belonging to this registry.

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

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()

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

api: 'Api',
organization: 'str',
name: 'str',
visibility: "Literal['organization', 'restricted']",
description: 'str | None' = None,
artifact_types: 'list[str] | None' = None

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.

Returns

Registry: The newly created Registry object.

Raises

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

method Registry.delete()

Delete the registry. This is irreversible.

self

method Registry.load()

Load registry attributes from the backend.

self

method Registry.members()

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

self

method Registry.remove_members()

Removes users or teams from this registry.

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

Arguments

User | UserMember | Team | TeamMember | str

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

Returns

This registry for further method chaining, if needed.

Raises

If no members are passed as arguments.

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()

Save registry attributes to the backend.

self

method Registry.team_members()

Returns the current member teams of this registry.

self

method Registry.update_member()

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

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

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)

Returns

This registry for further method chaining, if needed.

Raises

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()

Returns the current member users of this registry.

self

method Registry.versions()

Returns the artifact versions belonging to this registry.

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

Arguments

dict[str, Any] | None

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

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

method Registry.add_members()

Arguments

Returns

Raises

Examples

method Registry.collections()

Arguments

method Registry.create()

Arguments

Returns

Raises

method Registry.delete()

method Registry.load()

method Registry.members()

method Registry.remove_members()

Arguments

Returns

Raises

Examples

method Registry.save()

method Registry.team_members()

method Registry.update_member()

Arguments

Returns

Raises

Examples

method Registry.user_members()

method Registry.versions()

Arguments

​Class wandb.apis.public.Registry

​method Registry.add_members()

Arguments

Returns

Raises

Examples

​method Registry.collections()

Arguments

​method Registry.create()

Arguments

Returns

Raises

​method Registry.delete()

​method Registry.load()

​method Registry.members()

​method Registry.remove_members()

Arguments

Returns

Raises

Examples

​method Registry.save()

​method Registry.team_members()

​method Registry.update_member()

Arguments

Returns

Raises

Examples

​method Registry.user_members()

​method Registry.versions()

Arguments

Class wandb.apis.public.Registry

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()