Workspaces

# Importation
import wandb_workspaces.workspaces as ws
import wandb_workspaces.reports.v2 as wr

# Exemple de création d’un workspace
ws.Workspace(
     name="Example W&B Workspace",
     entity="entity", # entity propriétaire du workspace
     project="project", # projet associé au workspace
     sections=[
         ws.Section(
             name="Validation Metrics",
             panels=[
                 wr.LinePlot(x="Step", y=["val_loss"]),
                 wr.BarPlot(metrics=["val_accuracy"]),
                 wr.ScalarChart(metric="f1_score", groupby_aggfunc="mean"),
             ],
             is_open=True,
         ),
     ],
)
workspace.save()

​

classe RunSettings

• color (str) : couleur du run dans l’interface utilisateur. Il peut s’agir d’une valeur hexadécimale (#ff0000), d’un nom de couleur CSS (red) ou d’une valeur RGB (rgb(255, 0, 0))
• disabled (bool) : indique si le run est désactivé (œil fermé dans l’interface utilisateur). La valeur par défaut est False.

​

classe RunsetSettings

• query (str) : Requête permettant de filtrer le runset (peut être une expression regex, voir le paramètre suivant).
• regex_query (bool) : Indique si la requête (ci-dessus) est une expression regex. La valeur par défaut est False.
• filters (Union[str, LList[FilterExpr], Or, And]) : Filtres du runset.
  • Sous forme de liste de FilterExpr : les filtres sont combinés avec AND.
  • Sous forme de chaîne : expressions de type Python, par exemple « Config(‘lr’) = 0.001 and State = ‘finished’ »
• Supports operators : =, ==, !=, <, >, <=, >=, in, not in, and, or
  • Sous forme de combinateur Or/And : permet d’utiliser la logique OR et des groupes imbriqués. Par exemple, Or(And(Config(“lr”) == 0.01, Metric(“State”) == “finished”), Config(“lr”) == 0.1)
• groupby (LList[expr.MetricType]) : Liste de métriques selon lesquelles regrouper le runset. Valeurs possibles : Metric, Summary, Config, Tags ou KeysInfo.
• order (LList[expr.Ordering]) : Liste de métriques et d’ordres de tri à appliquer au runset.
• run_settings (Dict[str, RunSettings]) : Dictionnaire de paramètres de run, dont la clé est l’ID du run et la valeur un objet RunSettings.
• pinned_columns (LList[str]) : Liste des noms de colonnes à épingler.
• Column names use format : “run:displayName”, “summary:metric”, “config:param”.
• run : displayName est ajouté automatiquement s’il est absent.
• Example : [“summary:accuracy”, “summary:loss”]
• baseline_run (Optional[str]) : Slug W&B du run de référence (la valeur de wandb.Run.id, par exemple "1mbku38n", qui correspond aussi au dernier segment du chemin de l’URL d’un run). Utilisé pour les colonnes de delta et le style de comparaison. Lorsqu’il est défini, le run de référence est automatiquement ajouté à pinned_runs, conformément au comportement de la W&B App. Doit désigner un run appartenant au projet du workspace : l’épinglage entre projets n’est pas encore pris en charge par ce SDK (pour l’équivalent dans l’interface, consultez le volet latéral « Add cross-project runs » de la W&B App).
• pinned_runs (LList[str]) : Liste ordonnée de slugs de runs W&B à garder visibles dans le sélecteur de runs et toujours récupérés pour les graphiques. Transmettez des chaînes de slug (wandb.Run.id), et non des ID GraphQL. La W&B App limite cette liste à 20 entrées.

    # Avec des filtres sous forme de chaîne (nouveau)
    RunsetSettings(
         filters="Config('learning_rate') = 0.001 and State = 'finished'",
         pinned_columns=["summary:accuracy", "summary:loss"],
         baseline_run="1mbku38n",  # wandb.Run.id (le slug figurant dans l’URL)
         pinned_runs=["1mbku38n", "2u1g3j1c"],
    )

    # Avec une liste de FilterExpr (méthode d’origine)
    RunsetSettings(
         filters=[expr.Config("learning_rate") == 0.001],
         pinned_columns=["summary:accuracy", "summary:loss"],
    )

​

méthode convert_filterexpr_list_to_string

convert_filterexpr_list_to_string()

​

méthode ensure_baseline_pinned

ensure_baseline_pinned()

​

méthode validate_and_setup_columns

validate_and_setup_columns()

​

classe Section

• name (str) : Le nom ou titre de la section.
• panels (LList[PanelTypes]) : Liste ordonnée des panneaux de la section. Par défaut, le premier se trouve en haut à gauche et le dernier en bas à droite.
• is_open (bool) : Indique si la section est ouverte ou fermée. Par défaut, elle est fermée.
• pinned (bool) : Indique si la section est épinglée. Les sections épinglées s’affichent en haut du workspace. Par défaut : False.
• layout_settings (SectionLayoutSettings) : Paramètres de mise en page des panneaux de la section.
• panel_settings : Paramètres de panneau appliqués à tous les panneaux de la section, à l’image de WorkspaceSettings pour une Section.

​

classe SectionLayoutSettings

• columns (int) : Le nombre de colonnes de la mise en page. Par défaut : 3.
• rows (int) : Le nombre de lignes de la mise en page. Par défaut : 2.

​

classe SectionPanelSettings

• x_axis (str) : Nom de la métrique utilisée pour l’axe X. Valeur par défaut : “Step”.
• x_min Optional[float] : Valeur minimum de l’axe X.
• x_max Optional[float] : Valeur maximum de l’axe X.
• smoothing_type (Literal[‘exponentialTimeWeighted’, ‘exponential’, ‘gaussian’, ‘average’, ‘none’]) : Type de lissage appliqué à tous les panneaux.
• smoothing_weight (int) : Poids de lissage appliqué à tous les panneaux.

​

classe Workspace

• entity (str) : L’entity dans laquelle ce workspace sera enregistré (généralement un nom d’utilisateur ou d’équipe).
• project (str) : Le projet dans lequel ce workspace sera enregistré.
• name : Le nom du workspace.
• sections (LList[Section]) : Liste ordonnée des sections du workspace. La première section s’affiche en haut du workspace.
• settings (WorkspaceSettings) : Paramètres du workspace, généralement affichés en haut du workspace dans l’interface utilisateur.
• runset_settings (RunsetSettings) : Paramètres du runset (la barre latérale gauche qui contient les runs) d’un workspace.
• auto_generate_panels (bool) : Indique si des panneaux doivent être générés automatiquement pour toutes les clés journalisées dans ce projet. Recommandé si vous souhaitez que toutes les données disponibles soient visualisées par défaut. Ce paramètre ne peut être défini qu’à la création du workspace et ne peut plus être modifié ensuite.

​

propriété auto_generate_panels

​

propriété url

​

classmethod from_url

from_url(url: str)

​

méthode save

save()

• Workspace : le workspace mis à jour, avec le nom interne et l’ID enregistrés.

​

méthode save_as_new_view

save_as_new_view()

• Workspace : le workspace mis à jour, avec le nom interne et l’ID enregistrés.

​

classe WorkspaceSettings

• x_axis (str) : Nom de la métrique utilisée pour l’axe X.
• x_min (Optional[float]) : Valeur minimale de l’axe X.
• x_max (Optional[float]) : Valeur maximale de l’axe X.
• smoothing_type (Literal[‘exponentialTimeWeighted’, ‘exponential’, ‘gaussian’, ‘average’, ‘none’]) : Type de lissage appliqué à tous les panneaux.
• smoothing_weight (int) : Poids de lissage appliqué à tous les panneaux.
• ignore_outliers (bool) : Ignore les valeurs aberrantes dans tous les panneaux.
• sort_panels_alphabetically (bool) : Trie par ordre alphabétique les panneaux de toutes les sections.
• group_by_prefix (Literal[“first”, “last”]) : Regroupe les panneaux selon le premier préfixe ou jusqu’au dernier préfixe (first ou last). Valeur par défaut : last.
• remove_legends_from_panels (bool) : Supprime les légendes de tous les panneaux.
• tooltip_number_of_runs (Literal[“default”, “all”, “none”]) : Nombre de runs à afficher dans l’infobulle.
• tooltip_color_run_names (bool) : Indique si les noms des runs sont colorés dans l’infobulle pour correspondre au runset (True) ou non (False). Valeur par défaut : True.
• max_runs (int) : Nombre maximal de runs à afficher par panneau (il s’agit des 10 premiers runs du runset).
• point_visualization_method (Literal[“line”, “point”, “line_point”]) : Méthode de visualisation des points.
• panel_search_query (str) : Requête de la barre de recherche des panneaux (peut être une expression régulière).
• auto_expand_panel_search_results (bool) : Indique si les résultats de la recherche de panneaux sont développés automatiquement.