Artifact

​

classe wandb.Artifact

name: 'str',
type: 'str',
description: 'str | None' = None,
metadata: 'dict[str, Any] | None' = None,
incremental: 'bool' = False,
use_as: 'str | None' = None,
storage_region: 'str | None' = None

• name: Un nom facile à lire pour l’artifact. Utilisez ce nom pour identifier un artifact spécifique dans l’interface de l’application W&B ou par programmation. Vous pouvez référencer un artifact de manière interactive avec l’API publique use_artifact. Un nom peut contenir des lettres, des chiffres, des traits de soulignement, des traits d’union et des points. Le nom doit être unique dans un projet.
• type: Le type de l’artifact. Utilisez le type d’un artifact pour organiser et différencier les Artifacts. Vous pouvez utiliser n’importe quelle chaîne contenant des lettres, des chiffres, des traits de soulignement, des traits d’union et des points. Les types courants incluent dataset ou model. Incluez model dans votre chaîne de type si vous souhaitez lier l’artifact au registre de modèles W&B. Notez que certains types sont réservés à un usage interne et ne peuvent pas être définis par les utilisateurs. Ces types incluent job et les types qui commencent par wandb-.
• description: Une description de l’artifact. Pour les Artifacts de type Model ou Dataset, ajoutez la documentation de votre carte de modèle ou de jeu de données standardisée pour l’équipe. Consultez la description d’un artifact par programmation avec l’attribut Artifact.description ou dans l’interface de l’application W&B. W&B affiche la description au format markdown dans l’application W&B.
• metadata: Informations supplémentaires sur un artifact. Spécifiez les métadonnées sous la forme d’un dictionnaire de paires clé-valeur. Vous ne pouvez pas spécifier plus de 100 clés au total.
• incremental: Utilisez plutôt la méthode Artifact.new_draft() pour modifier un artifact existant.
• use_as: Obsolète.
• storage_region:

​

propriété aliases

​

propriété collection

​

propriété commit_hash

​

propriété created_at

​

propriété description

​

propriété digest

​

propriété entité

​

propriété file_count

​

propriété history_step

​

propriété id

​

propriété is_link

​

propriété linked_artifacts

​

propriété manifest

​

propriété metadata

​

propriété name

​

propriété project

​

propriété qualified_name

​

propriété size

​

propriété source_artifact

​

propriété source_collection

​

propriété source_entity

​

propriété source_name

​

propriété source_project

​

propriété source_qualified_name

​

propriété source_version

​

propriété state

​

propriété tags

​

propriété ttl

​

propriété type

​

propriété updated_at

​

propriété url

​

propriété use_as

​

propriété version

​

méthode Artifact.add()

self,
obj: 'WBValue',
name: 'StrPath',
overwrite: 'bool' = False

• obj: L’objet à ajouter. Prend actuellement en charge l’un des types suivants : Bokeh, JoinedTable, PartitionedTable, Table, Classes, ImageMask, BoundingBoxes2D, Audio, Image, Video, Html, Object3D
• name: Le chemin dans l’artifact auquel ajouter l’objet.
• overwrite: Si True, remplace les objets existants ayant le même chemin de fichier, le cas échéant.

• ArtifactFinalizedError: Vous ne pouvez pas modifier la version actuelle de l’artifact, car elle est finalisée. Enregistrez plutôt une nouvelle version de l’artifact.

​

méthode Artifact.add_dir()

self,
local_path: 'str',
name: 'str | None' = None,
skip_cache: 'bool | None' = False,
policy: "Literal['mutable', 'immutable'] | None" = 'mutable',
merge: 'bool' = False

• local_path: Le chemin du répertoire local.
• name: Le nom du sous-répertoire dans un artifact. Le nom que vous indiquez apparaît dans l’UI de l’application W&B, sous le type de l’artifact. Par défaut, il correspond à la racine de l’artifact.
• skip_cache: Si défini sur True, W&B ne copiera ni ne déplacera les fichiers vers le cache pendant l’upload
• policy: Par défaut, “mutable”.
  • mutable: Crée une copie temporaire du fichier pour éviter toute corruption pendant l’upload.
  • immutable: Désactive la protection et suppose que l’utilisateur ne supprimera ni ne modifiera le fichier.
• merge: Si False (par défaut), lève une ValueError si un fichier a déjà été ajouté lors d’un précédent appel à add_dir et que son contenu a changé. Si True, écrase les fichiers existants dont le contenu a changé. Ajoute toujours les nouveaux fichiers et ne supprime jamais de fichiers. Pour remplacer un répertoire entier, passez un nom lors de l’ajout du répertoire avec add_dir(local_path, name=my_prefix) et appelez remove(my_prefix) pour supprimer le répertoire, puis ajoutez-le de nouveau.

• ArtifactFinalizedError: Vous ne pouvez pas modifier la version actuelle de l’artifact, car elle est finalisée. Créez plutôt une nouvelle version de l’artifact.
• ValueError: La stratégie doit être “mutable” ou “immutable”

​

méthode Artifact.add_file()

self,
local_path: 'str',
name: 'str | None' = None,
is_tmp: 'bool | None' = False,
skip_cache: 'bool | None' = False,
policy: "Literal['mutable', 'immutable'] | None" = 'mutable',
overwrite: 'bool' = False

• local_path: Le chemin du fichier à ajouter.
• name: Le chemin à utiliser dans l’artifact pour le fichier ajouté. La valeur par défaut est le nom de base du fichier.
• is_tmp: Si la valeur est true, le fichier est renommé de manière déterministe pour éviter les collisions.
• skip_cache: Si la valeur est True, ne copiez pas les fichiers dans le cache après le téléversement.
• policy: Par défaut, la valeur est définie sur “mutable”. Si elle est définie sur “mutable”, créez une copie temporaire du fichier pour éviter toute corruption pendant le téléversement. Si elle est définie sur “immutable”, désactivez la protection et supposez que l’utilisateur ne supprimera pas et ne modifiera pas le fichier.
• overwrite: Si la valeur est True, remplacez le fichier s’il existe déjà.

• ArtifactFinalizedError: Vous ne pouvez pas modifier la version actuelle de l’artifact, car elle est finalisée. Créez plutôt une nouvelle version de l’artifact.
• ValueError: La stratégie doit être “mutable” ou “immutable”

​

méthode Artifact.add_reference()

self,
uri: 'ArtifactManifestEntry | str',
name: 'StrPath | None' = None,
checksum: 'bool' = True,
max_objects: 'int | None' = None

• http(s) : la taille et le digest du fichier sont déduites des en-têtes de réponse Content-Length et ETag renvoyés par le serveur.
• s3 : la somme de contrôle et la taille sont récupérées à partir des métadonnées de l’objet. Si la gestion des versions du bucket est activée, l’ID de version est également suivi.
• gs : la somme de contrôle et la taille sont récupérées à partir des métadonnées de l’objet. Si la gestion des versions du bucket est activée, l’ID de version est également suivi.
• https, domaine correspondant à *.blob.core.windows.net
• Azure : la somme de contrôle et la taille sont récupérées à partir des métadonnées du blob. Si la gestion des versions du compte de stockage est activée, l’ID de version est également suivi.
• file : la somme de contrôle et la taille sont récupérées à partir du système de fichiers. Ce schéma est utile si vous avez un partage NFS ou un autre volume monté en externe contenant des fichiers que vous souhaitez suivre sans nécessairement les téléverser.

• uri : le chemin URI de la référence à ajouter. Le chemin URI peut être un objet renvoyé par Artifact.get_entry pour stocker une référence vers l’entrée d’un autre artifact.
• name : le chemin au sein de l’artifact où placer le contenu de cette référence.
• checksum : indique s’il faut calculer ou non une somme de contrôle pour la ou les ressources situées à l’URI de référence. Le calcul de la somme de contrôle est fortement recommandé, car il permet une validation automatique de l’intégrité. Le désactiver accélère la création de l’artifact, mais les répertoires de référence ne seront pas parcourus, de sorte que les objets du répertoire ne seront pas enregistrés dans l’artifact. Nous vous recommandons de définir checksum=False lors de l’ajout d’objets de référence ; dans ce cas, une nouvelle version ne sera créée que si l’URI de référence change.
• max_objects : le nombre maximal d’objets à prendre en compte lors de l’ajout d’une référence pointant vers un répertoire ou un préfixe de stockage de bucket. Par défaut, le nombre maximal d’objets autorisé pour Amazon S3, GCS, Azure et les fichiers locaux est de 10,000,000. Les autres schémas d’URI n’ont pas de limite.

• ArtifactFinalizedError: Vous ne pouvez pas modifier la version actuelle de l’artifact, car elle est finalisée. Enregistrez plutôt une nouvelle version de l’artifact.

​

méthode Artifact.checkout()

self,
root: 'str | None' = None

• root : le répertoire à remplacer par les fichiers de cet artifact.

• ArtifactNotLoggedError: Si l’artifact n’est pas enregistré.

​

méthode Artifact.delete()

self,
delete_aliases: 'bool' = False

• delete_aliases: Si défini sur True, supprime tous les alias associés à l’artifact. Si False, lève une exception si l’artifact possède déjà des alias. Ce paramètre est ignoré si l’artifact est récupéré depuis une collection à laquelle il est lié.

• ArtifactNotLoggedError: Si l’artifact n’est pas enregistré.

​

méthode Artifact.download()

self,
root: 'StrPath | None' = None,
allow_missing_references: 'bool' = False,
skip_cache: 'bool | None' = None,
path_prefix: 'StrPath | None' = None,
multipart: 'bool | None' = None

• root: Le répertoire dans lequel W&B stocke les fichiers de l’artifact.
• allow_missing_references: Si défini sur True, tous les chemins de référence invalides seront ignorés lors du téléchargement des fichiers référencés.
• skip_cache: Si défini sur True, le cache de l’artifact sera ignoré lors du téléchargement, et W&B téléchargera chaque fichier dans le répertoire racine par défaut ou dans le répertoire de téléchargement spécifié.
• path_prefix: Si spécifié, seuls les fichiers dont le chemin commence par le préfixe indiqué seront téléchargés. Utilise le format Unix (barres obliques /).
• multipart: Si défini sur None (par défaut), l’artifact sera téléchargé en parallèle à l’aide d’un téléchargement multipart si la taille d’un fichier individuel dépasse 2 Go. Si défini sur True ou False, l’artifact sera téléchargé en parallèle ou en série, quelle que soit la taille du fichier.

• ArtifactNotLoggedError: Si l’artifact n’est pas enregistré.

​

méthode Artifact.file()

self,
root: 'str | None' = None

• root: Le répertoire racine dans lequel stocker le fichier. Valeur par défaut : ./artifacts/self.name/.

• ArtifactNotLoggedError : Si l’artifact n’est pas enregistré.
• ValueError : Si l’artifact contient plus d’un fichier.

​

méthode Artifact.files()

self,
names: 'list[str] | None' = None,
per_page: 'int' = 50,
start: 'str | None' = None

• names : Les chemins des fichiers, relatifs à la racine de l’artifact, que vous souhaitez lister.
• per_page : Le nombre de fichiers à renvoyer par requête.
• start : Curseur de pagination pour reprendre une requête précédente, capturé à partir de l’attribut .cursor d’un paginateur précédent.

• ArtifactNotLoggedError: Si l’artifact n’est pas enregistré.

​

méthode Artifact.finalize()

self

​

méthode Artifact.get()

self,
name: 'str'

• name: Le nom relatif dans l’artifact à récupérer.

• ArtifactNotLoggedError: si l’artifact n’est pas enregistré ou si le run est hors ligne.

​

méthode Artifact.get_added_local_path_name()

self,
local_path: 'str'

• local_path: Le chemin local à convertir en nom relatif dans l’artifact.

​

méthode Artifact.get_entry()

self,
name: 'StrPath'

• name: Le nom relatif de l’artifact à récupérer

• ArtifactNotLoggedError: si l’artifact n’est pas enregistré ou si le run est hors ligne.
• KeyError: si l’artifact ne contient pas d’entrée portant le nom indiqué.

​

méthode Artifact.get_path()

self,
name: 'StrPath'

• name:

​

méthode Artifact.is_draft()

self

​

méthode Artifact.json_encode()

self

​

méthode Artifact.link()

self,
target_path: 'str',
aliases: 'Iterable[str] | None' = None

• target_path: Chemin de la collection. Il se compose du préfixe “wandb-registry-”, ainsi que du nom du registre et du nom de la collection : wandb-registry-{REGISTRY_NAME}/{COLLECTION_NAME}.
• aliases: Ajoutez un ou plusieurs alias à l’artifact lié. L’alias “latest” est automatiquement appliqué à l’artifact le plus récent que vous liez.

• ArtifactNotLoggedError: Si l’artifact n’est pas enregistré.

​

méthode Artifact.logged_by()

self

• ArtifactNotLoggedError: Si l’artifact n’est pas enregistré.

​

méthode Artifact.new_draft()

self

• ArtifactNotLoggedError: Si l’artifact n’est pas enregistré.

​

méthode Artifact.new_file()

self,
name: 'str',
mode: 'str' = 'x',
encoding: 'str | None' = None

• name: Le nom du nouveau fichier à ajouter à l’artifact.
• mode: Le mode d’accès à utiliser pour ouvrir le nouveau fichier.
• encoding: L’encodage utilisé pour ouvrir le nouveau fichier.

• ArtifactFinalizedError: Vous ne pouvez pas modifier la version actuelle de l’artifact, car elle est finalisée. Enregistrez plutôt une nouvelle version de l’artifact.

​

méthode Artifact.remove()

self,
item: 'StrPath | ArtifactManifestEntry'

• item: Élément à supprimer. Il peut s’agir d’une entrée de manifeste spécifique ou du nom d’un chemin relatif à l’artifact. Si l’élément correspond à un répertoire, tous les éléments de ce répertoire seront supprimés.

• ArtifactFinalizedError: Vous ne pouvez pas modifier la version actuelle de l’artifact, car elle est finalisée. Enregistrez plutôt une nouvelle version de l’artifact.
• FileNotFoundError: Si l’élément est introuvable dans l’artifact.

​

méthode Artifact.save()

self,
project: 'str | None' = None,
settings: 'wandb.Settings | None' = None

• project: Projet à utiliser pour l’artifact si aucun run n’est déjà actif dans le contexte.
• settings: Objet de paramètres à utiliser lors de l’initialisation d’un run automatique. Principalement utilisé dans une infrastructure de test.

​

méthode Artifact.unlink()

self

• ArtifactNotLoggedError: Si l’artifact n’est pas enregistré.
• ValueError: Si l’artifact n’est pas lié à aucune collection.

​

méthode Artifact.used_by()

self

• ArtifactNotLoggedError: Si l’artifact n’est pas enregistré.

​

méthode Artifact.verify()

self,
root: 'str | None' = None

• root: Le répertoire à vérifier. Si None, l’artifact sera téléchargé dans ’./artifacts/self.name/’.

• ArtifactNotLoggedError: Si l’artifact n’est pas enregistré.
• ValueError: Si la vérification échoue.

​

méthode Artifact.wait()

self,
timeout: 'int | None' = None

• timeout: le temps d’attente, en secondes.