Registre

Classe wandb.apis.public.Registry

Un seul registre dans le Registre.

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

Arguments

ServiceApi

Aucune description fournie.

str

Aucune description fournie.

str

Aucune description fournie.

str

Aucune description fournie.

RegistryFragment | None

Aucune description fournie.

Propriétés

bool

Indique si tous les types d’artefacts sont autorisés dans le registre.Si True, des artefacts de tout type peuvent être ajoutés. Si False, les artefacts sont restreints aux types répertoriés dans artifact_types.

AddOnlyArtifactTypesList

Renvoie les types d’artefacts autorisés dans le registre.Si allow_all_artifact_types est True, artifact_types reflète les types précédemment enregistrés ou actuellement utilisés dans le registre. Si allow_all_artifact_types est False, les artefacts sont restreints aux types figurant dans artifact_types.Remarque : Les types d’artefacts précédemment enregistrés ne peuvent pas être supprimés.

str

Horodatage de la création du registre.

str | None

Description du registre.

str

Entité d’organisation du registre.

str

Nom complet du registre, incluant le préfixe wandb-registry-.

str

ID unique de ce registre.

str | None

internalId GraphQL du projet sous-jacent de ce registre, s’il a été récupéré.Il s’agit d’un ID global encodé en base64. Une fois décodé, il se présente sous la forme Project:123 ou ProjectInternalId:123.

str

Nom du registre sans le préfixe wandb-registry-.

str

Nom de l’organisation du registre.

list[str]

Aucune description fournie.

str | None

Horodatage de la dernière mise à jour du registre.

The visibility level.

Visibilité du registre.

Méthodes

méthode Registry.add_members()

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

Ajoute des Users ou des équipes à ce registre.

Arguments

User | UserMember | Team | TeamMember | str

Les Users ou équipes à ajouter au registre. Accepte des objets User, des objets Team ou leurs ID sous forme de chaîne.

Exceptions levées

TypeError: Si aucun membre n’est passé en argument.
ValueError: S’il est impossible de déduire ou d’analyser les ID d’utilisateur ou d’équipe.

Exemples

import wandb

api = wandb.Api()

# Récupérer un registre existant
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)

méthode Registry.collections()

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

Renvoie les collections appartenant à ce registre.

Arguments

dict[str, Any] | None

Mappage facultatif des filtres à appliquer à la requête de collections.

str | None

Chaîne facultative permettant de spécifier l’ordre des résultats. S’il est préfixé par ’+’, le tri est croissant (par défaut). S’il est préfixé par ’-’, le tri est décroissant.

PositiveInt

Nombre de résultats à récupérer par page. Il n’est généralement pas nécessaire de le modifier.

str | None

Curseur de pagination permettant de reprendre une requête antérieure, obtenu à partir de l’attribut .cursor d’un paginateur précédent.

méthode Registry.create()

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

Créer un nouveau registre. Le nom du registre doit être unique au sein de l’organisation. Cette fonction doit être appelée via api.create_registry()

Arguments

Api

L’instance d’API W&B.

str

Le nom de l’organisation.

str

Le nom du registre (sans le préfixe wandb-registry-).

Literal['organization', 'restricted']

Le niveau de visibilité (« organization » ou « restricted »).

str | None

Une description facultative du registre.

list[str] | None

Une liste facultative des types d’artefacts autorisés.

Exceptions levées

ValueError: Si un registre portant le même nom existe déjà dans l’organisation, ou si sa création échoue.

méthode Registry.delete()

self

Supprimez le registre. Cette action est irréversible.

méthode Registry.load()

self

Charge les attributs du registre à partir du backend.

méthode Registry.members()

self

Renvoie les membres actuels (Users et équipes) de ce registre.

méthode Registry.remove_members()

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

Supprime des Users ou des équipes de ce registre.

Arguments

User | UserMember | Team | TeamMember | str

Les Users ou équipes à supprimer du registre. Accepte des objets User, des objets Team ou leurs ID sous forme de chaîne.

Exceptions levées

TypeError: Si aucun membre n’est passé en argument.
ValueError: S’il est impossible de déduire ou d’analyser les ID d’utilisateur ou d’équipe.

Exemples

import wandb

api = wandb.Api()

# Récupérer un registre existant
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)

méthode Registry.save()

self

Enregistrer les attributs du registre dans le backend.

méthode Registry.team_members()

self

Renvoie les équipes actuellement membres de ce registre.

méthode Registry.update_member()

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

Met à jour le rôle d’un membre (utilisateur ou équipe) dans ce registre.

Arguments

User | UserMember | Team | TeamMember | str

L’utilisateur ou l’équipe dont le rôle doit être mis à jour. Accepte un objet User, un objet Team ou leur ID sous forme de chaîne.

MemberRole | str

Le nouveau rôle à attribuer au membre. Peut être l’un des suivants :

“admin”
“member”
“viewer”
“restricted_viewer” (si pris en charge par le serveur W&B)

Exceptions levées

ValueError: S’il est impossible de déterminer l’ID de l’utilisateur ou de l’équipe.

Exemples

Faites de tous les utilisateurs du registre des administrateurs

import wandb

api = wandb.Api()

# Récupérer un registre existant
registry = api.registry(name="my-registry", organization="my-org")

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

méthode Registry.user_members()

self

Renvoie les utilisateurs actuellement membres de ce registre.

méthode Registry.versions()

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

Renvoie les versions d’artifact de ce registre.

Arguments

dict[str, Any] | None

Mappage facultatif des filtres à appliquer à la requête de versions d’artifact.

_VersionOrder | None

Chaîne facultative permettant de spécifier l’ordre des résultats. L’ordre peut être created_at, artifact_size ou linked_at. Préfixé par ’+’, le tri est croissant (par défaut). Préfixé par ’-’, le tri est décroissant.

PositiveInt

Le nombre de résultats à récupérer par page. En général, il n’y a aucune raison de modifier cette valeur.

str | None

Curseur de pagination pour reprendre une requête précédente, capturé à partir de l’attribut .cursor d’un paginateur précédent.

W&B Models

W&B Weave

Serverless Inference

Serverless Training

Classe wandb.apis.public.Registry

Arguments

Propriétés

Méthodes

méthode Registry.add_members()

Arguments

Exceptions levées

Exemples

méthode Registry.collections()

Arguments

méthode Registry.create()

Arguments

Exceptions levées

méthode Registry.delete()

méthode Registry.load()

méthode Registry.members()

méthode Registry.remove_members()

Arguments

Exceptions levées

Exemples

méthode Registry.save()

méthode Registry.team_members()

méthode Registry.update_member()

Arguments

Exceptions levées

Exemples

méthode Registry.user_members()

méthode Registry.versions()

Arguments

​Classe wandb.apis.public.Registry

​Arguments

​Propriétés

​Méthodes

​méthode Registry.add_members()

Arguments

Exceptions levées

Exemples

​méthode Registry.collections()

Arguments

​méthode Registry.create()

Arguments

Exceptions levées

​méthode Registry.delete()

​méthode Registry.load()

​méthode Registry.members()

​méthode Registry.remove_members()

Arguments

Exceptions levées

Exemples

​méthode Registry.save()

​méthode Registry.team_members()

​méthode Registry.update_member()

Arguments

Exceptions levées

Exemples

​méthode Registry.user_members()

​méthode Registry.versions()

Arguments

Classe wandb.apis.public.Registry

Arguments

Propriétés

Méthodes

méthode Registry.add_members()

méthode Registry.collections()

méthode Registry.create()

méthode Registry.delete()

méthode Registry.load()

méthode Registry.members()

méthode Registry.remove_members()

méthode Registry.save()

méthode Registry.team_members()

méthode Registry.update_member()

méthode Registry.user_members()

méthode Registry.versions()