Skip to main content

classe wandb.apis.public.Registry

Un seul registre dans le Registre.

Arguments

  • service_api:
  • organization:
  • entity:
  • name:
  • attrs:

Propriétés

propriété allow_all_artifact_types

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

propriété artifact_types

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

propriété created_at

Horodatage de création du registre.

propriété description

Description du registre.

propriété entité

Entité de l’organisation du registre.

propriété full_name

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

propriété id

L’ID unique de ce registre.

propriété nom

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

propriété organisation

Nom de l’organisation du registre.

propriété chemin

propriété updated_at

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

propriété visibility

Visibilité du registre.

Méthodes

méthode Registry.add_members()

Ajoute des Users ou des équipes à ce registre.
Arguments
  • members: 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

méthode Registry.collections()

Renvoie les collections appartenant à ce registre.
Arguments
  • filter : Mappage facultatif des filtres à appliquer à la requête de collections.
  • order : 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.
  • per_page : Nombre de résultats à récupérer par page. Il n’est généralement pas nécessaire de le modifier.
  • start : 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()

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.
  • organization: Le nom de l’organisation.
  • name: Le nom du registre (sans le préfixe wandb-registry-).
  • visibility: Le niveau de visibilité ('organization' ou 'restricted').
  • description: Une description facultative du registre.
  • artifact_types: Une liste facultative des types d’artifact 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()

Supprimez le registre. Cette action est irréversible.

méthode Registry.load()

Charge les attributs du registre à partir du backend.

méthode Registry.members()

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

méthode Registry.remove_members()

Supprime des Users ou des équipes de ce registre.
Arguments
  • members: 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

méthode Registry.save()

Enregistrer les attributs du registre dans le backend.

méthode Registry.team_members()

Renvoie les équipes actuellement membres de ce registre.

méthode Registry.update_member()

Met à jour le rôle d’un membre (utilisateur ou équipe) dans ce registre.
Arguments
  • member: 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.
  • role: 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

méthode Registry.user_members()

Renvoie les utilisateurs actuellement membres de ce registre.

méthode Registry.versions()

Renvoie les versions d’artifact de ce registre.
Arguments
  • filter: Mappage facultatif des filtres à appliquer à la requête de versions d’artifact.
  • per_page: Le nombre de résultats à récupérer par page. En général, il n’y a aucune raison de modifier cette valeur.
  • start: Curseur de pagination pour reprendre une requête précédente, capturé à partir de l’attribut .cursor d’un paginateur précédent.