Passer au contenu principal

​
class Sweep

L’ensemble des runs associés au balayage. Attributs :
  • runs (Runs) : Liste des runs
  • id (str) : ID du balayage
  • project (str) : Nom du projet auquel le balayage appartient
  • config (dict) : Dictionnaire contenant la configuration du balayage
  • state (str) : État du balayage. Peut être “Finished”, “Failed”, “Crashed” ou “Running”.
  • expected_run_count (int) : Nombre de runs attendus pour le balayage

​
méthode Sweep.__init__

__init__(
    client: 'RetryingClient',
    entity: 'str',
    project: 'str',
    sweep_id: 'str',
    attrs: 'Mapping[str, Any] | None' = None
)

​
propriété Sweep.config

Configuration du balayage utilisée pour ce balayage.

​
propriété Sweep.entity

L’entité associée au balayage. Retourne :
  • str : La valeur de la propriété entité.

​
propriété Sweep.expected_run_count

Retourne le nombre de runs attendus dans le balayage, ou None si le nombre de runs est infini. Retourne :
  • int | None: La valeur de propriété expected_run_count.

​
propriété Sweep.name

Le nom du balayage. Renvoie le premier nom disponible selon l’ordre de priorité suivant :
  1. Nom d’affichage modifié par l’utilisateur 2. Nom défini lors de la création 3. ID du balayage

​
propriété Sweep.order

Renvoie la clé d’ordre du balayage.

​
propriété Sweep.path

Renvoie le chemin du projet. Le chemin est une liste qui contient l’entité, le nom du projet et l’ID du balayage.

​
propriété Sweep.url

L’URL du balayage. L’URL du balayage est générée à partir de l’entité, du projet, du terme « sweeps » et de ID du balayage.run_id. Pour les utilisateurs SaaS, elle se présente sous la forme https://wandb.ai/entity/project/sweeps/sweeps_ID.

​
propriété Sweep.username

Obsolète. Utilisez Sweep.entity à la place. Retourne :
  • str : La valeur de la propriété du nom d’utilisateur.

​
méthode Sweep.best_run

best_run(order=None)
Retourne le meilleur run, trié selon la métrique définie dans la configuration ou l’ordre fourni.

​
méthode de classe Sweep.get

get(
    client: 'RetryingClient',
    entity: 'str | None' = None,
    project: 'str | None' = None,
    sid: 'str | None' = None,
    order: 'str | None' = None,
    query: 'Document | None' = None,
    **kwargs
)
Exécute une requête sur le backend cloud. Arguments :
  • client: Le client à utiliser pour exécuter la requête.
  • entity: L’entité (nom d’utilisateur ou équipe) propriétaire du projet.
  • project: Le nom du projet depuis lequel récupérer le balayage.
  • sid: L’ID du balayage à interroger.
  • order: L’ordre dans lequel les runs du balayage sont renvoyés.
  • query: La requête à utiliser pour exécuter la requête.
  • **kwargs: Arguments nommés supplémentaires à transmettre à la requête.

​
méthode Sweep.to_html

to_html(height: 'int' = 420, hidden: 'bool' = False) → str
Génère du HTML contenant une iframe qui affiche ce balayage.