W&B Workspace は、チャートをカスタマイズしたりモデルの結果を探索したりするための、あなた専用のサンドボックスです。W&B Workspace は、Tables と Panel sections で構成されています。
- Tables: プロジェクトにログ記録されたすべての Runs がプロジェクトのテーブルにリストされます。各 Run のオン/オフの切り替え、色の変更、テーブルの展開によるノート、config、サマリーメトリクスの確認が可能です。
- Panel sections: 1つ以上の パネル を含むセクションです。新しいパネルを作成して整理し、Reports にエクスポートして Workspace のスナップショットを保存できます。
Workspace の種類
Workspace には主に Personal workspaces と Saved views の2つのカテゴリがあります。
- Personal workspaces: モデルの深い分析やデータ可視化のためのカスタマイズ可能な Workspace です。Workspace の所有者のみが編集内容を保存できます。チームメイトは Personal workspace を閲覧できますが、他人の Workspace に変更を加えることはできません。
- Saved views: Saved views は、Workspace のコラボレーション用スナップショットです。チーム内の誰でも Workspace の Saved views を閲覧、編集、保存できます。実験、Runs などのレビューや議論には Saved views を使用してください。
以下の画像は、Cécile-parker のチームメイトによって作成された複数の Personal workspaces を示しています。このプロジェクトには Saved views はありません。
Saved workspace views
カスタマイズされた Workspace view を使用して、チームのコラボレーションを向上させましょう。Saved Views を作成して、お好みのチャートやデータのセットアップを整理できます。
新しい Saved workspace view を作成する
- Personal workspace または Saved view に移動します。
- Workspace に編集を加えます。
- Workspace の右上隅にあるミートボールメニュー(3つの水平な点)をクリックします。Save as a new view をクリックします。
新しい Saved views は Workspace のナビゲーションメニューに表示されます。
Saved workspace view を更新する
変更を保存すると、Saved view の以前の状態が上書きされます。保存されていない変更は保持されません。W&B で Saved workspace view を更新するには:
- Saved view に移動します。
- Workspace 内のチャートやデータに必要な変更を加えます。
- Save ボタンをクリックして変更を確定します。
Workspace view への更新を保存する際、確認ダイアログが表示されます。今後このプロンプトを表示したくない場合は、保存を確定する前に Do not show this modal next time オプションを選択してください。
Saved workspace view を削除する
不要になった Saved views を削除します。
- 削除したい Saved view に移動します。
- view の右上の3つの水平線 (…) を選択します。
- Delete view を選択します。
- 削除を確定して、Workspace メニューからその view を削除します。
Workspace view を共有する
Workspace の URL を直接共有することで、カスタマイズした Workspace をチームと共有できます。その Workspace プロジェクトへのアクセス権を持つすべての Users は、その Workspace の Saved views を見ることができます。
Workspace templates
Workspace templates を使用すると、新しい Workspace の デフォルト設定 を使う代わりに、既存の Workspace と同じ設定を使用して素早く Workspace を作成できます。現在、Workspace template ではカスタムの 折れ線グラフ(line plot)設定 を定義できます。
デフォルトの Workspace 設定
デフォルトでは、新しい Workspace は折れ線グラフに対して以下の設定を使用します。
| X axis | デフォルト |
|---|
| Value | Step |
| Log scale | false |
| Y axis | デフォルト |
|---|
| Log scale | false |
| Smoothing | デフォルト |
|---|
| Type | Time weight EMA |
| Weight | 0 |
| Show original after smoothing | Off |
| Max number of runs | デフォルト |
|---|
| Max runs | 10 |
| Data | デフォルト |
|---|
| Point aggregation | Full fidelity |
| Grouping | デフォルト |
|---|
| Use grouping in charts | On |
| Group aggregation | Mean |
| Display preferences | デフォルト |
|---|
| Color run names | On |
| Display full run name | Off |
| Show X range in tooltip | Off |
| Tooltip runs | Default |
| Sync zoom across charts | Off |
| Show higlighted run only | Off |
Workspace template を設定する
- 任意の Workspace を開くか、新しく作成します。
- お好みに合わせて Workspace の 折れ線グラフ(line plot)設定 を設定します。
- 設定を Workspace template に保存します:
- Workspace の上部で、Undo と Redo の矢印アイコンの近くにあるアクションメニュー
... をクリックします。
- Save personal workspace template をクリックします。
- テンプレートの折れ線グラフ設定を確認し、Save をクリックします。
新しい Workspace はデフォルト設定の代わりにこれらの設定を使用するようになります。
Workspace template を表示する
Workspace template の現在の構成を確認するには:
- 任意のページから、右上隅のユーザーアイコンを選択します。ドロップダウンから User Settings を選択します。
- Personal workspace template セクションに移動します。Workspace template を使用している場合は、その構成が表示されます。そうでない場合、このセクションには詳細が表示されません。
Workspace template を更新する
Workspace template を更新するには:
- 任意の Workspace を開きます。
- Workspace の設定を変更します。例えば、含める Runs の数を
11 に設定します。
- 変更をテンプレートに保存するには、Undo と Redo 矢印アイコンの近くのアクションメニュー
... をクリックし、Update personal workspace template をクリックします。
- 設定を確認し、Update をクリックします。テンプレートが更新され、それを使用するすべての Workspace に再適用されます。
Workspace template を削除する
Workspace template を削除してデフォルト設定に戻すには:
- 任意のページから、右上隅のユーザーアイコンを選択します。ドロップダウンから User Settings を選択します。
- Personal workspace template セクションに移動します。Workspace template の構成が表示されます。
- Settings の横にあるゴミ箱アイコンをクリックします。
Dedicated Cloud およびセルフマネージド(Self-Managed)の場合、Workspace template の削除は v0.70 以上でサポートされています。古いバージョンの Server では、Workspace template を デフォルト設定 を使用するように更新してください。
プログラムによる Workspace の作成
wandb-workspaces は、プログラムで W&B の Workspace や Reports を操作するための Python ライブラリです。
wandb-workspaces を使用してプログラムで Workspace を定義します。
以下のような Workspace のプロパティを定義できます:
- パネルのレイアウト、色、セクションの順序を設定する。
- デフォルトの X軸、セクション順、折りたたみ状態などの Workspace 設定を行う。
- セクション内にパネルを追加・カスタマイズして Workspace view を整理する。
- URL を使用して既存の Workspace を読み込み、修正する。
- 既存の Workspace への変更を保存、または新しい view として保存する。
- シンプルな式を使用して、プログラムで Runs のフィルタリング、グループ化、ソートを行う。
- 色や表示状態などの設定で Run の見た目をカスタマイズする。
- 統合や再利用のために、ある Workspace から別の Workspace へ view をコピーする。
Workspace API のインストール
wandb に加えて、wandb-workspaces をインストールしていることを確認してください。
pip install wandb wandb-workspaces
プログラムで Workspace view を定義して保存する
import wandb_workspaces.reports.v2 as ws
# Workspace を定義
workspace = ws.Workspace(entity="your-entity", project="your-project", views=[...])
# Workspace を保存
workspace.save()
既存の view を編集する
# URL から既存の Workspace を取得
existing_workspace = ws.Workspace.from_url("workspace-url")
# 1番目の view を新しい設定で更新
existing_workspace.views[0] = ws.View(name="my-new-view", sections=[...])
existing_workspace.save()
Workspace の saved view を別の Workspace にコピーする
# 元の Workspace を取得
old_workspace = ws.Workspace.from_url("old-workspace-url")
old_workspace_view = old_workspace.views[0]
# 新しいプロジェクトに view をコピーして保存
new_workspace = ws.Workspace(entity="new-entity", project="new-project", views=[old_workspace_view])
new_workspace.save()
包括的な Workspace API の例については、wandb-workspace examples を参照してください。エンドツーエンドのチュートリアルについては、Programmatic Workspaces チュートリアルをご覧ください。