Python ライブラリ

• 1: init
• 2: launch-library
• 2.1: launch_add
• 2.2: LaunchAgent
• 2.3: ローンチ
• 3: run
• 4: sweep
• 5: wandb_ワークスペース
• 5.1: ワークスペース
• 5.2: レポート
• 6: watch
• 7: アーティファクト
• 8: インポート＆エクスポート API
• 8.1: Api API (Application Programming Interface) は、プログラム間でデータや機能をやり取りするためのインターフェースを提供します。W&B API は、ユーザーがwandb を通じて**Projects**、**Entities**、**Runs**などのデータにアクセスし、管理することを可能にします。このAPIにより、**Experiments**の追跡や**Reports**の共有を自動化できます。W&B APIはPythonを含むさまざまなプログラミング言語で利用可能です。これにより、カスタムスクリプトの作成や他のツールとの統合が簡単になります。APIの使用方法に関する詳細な情報は、[API documentation](https://wandb.ai)を参照してください。
• 8.2: QueuedRun
• 8.3: run
• 8.4: Run
• 8.5: RunQueue
• 8.6: Sweep
• 8.7: ジョブ
• 8.8: ファイル
• 8.9: プロジェクト
• 8.10: プロジェクト
• 8.11: 申し訳ありませんが、私は提供された文書の翻訳を行うためのテキストが不足しています。何か特定のテキストまたは文書を提供していただければ、それを翻訳いたします。それに基づいて正確な翻訳を提供できますので、どうぞよろしくお願いします。
• 9: インテグレーション
• 9.1: keras
• 9.1.1: Wandb コールバック
• 9.1.2: WandbEvalCallback
• 9.1.3: WandbMetricsLogger
• 9.1.4: WandbModelCheckpoint
• 10: エージェント
• 11: データタイプ
• 11.1: BoundingBoxes2D
• 11.2: I'm sorry, it seems like there is no text to translate. Please provide the content you want to be translated.
• 11.3: ImageMask
• 11.4: Molecule
• 11.5: Object3D
• 11.6: Plotly
• 11.7: WBTraceツリー
• 11.8: イメージ
• 11.9: テーブル
• 11.10: オーディオ
• 11.11: グラフ
• 11.12: ヒストグラム
• 11.13: ビデオ
• 12: コントローラ
• 13: ログ
• 14: ログイン
• 15: 申し訳ありませんが、提供されたテキストが空白であるため、翻訳が必要なコンテンツが表示されません。それを解決していただければ、翻訳を提供いたします。
• 16: 保存

1 - init

新規のRunを開始して、W&Bにトラックしてログします。

init(
    entity: (str | None) = None,
    project: (str | None) = None,
    dir: (StrPath | None) = None,
    id: (str | None) = None,
    name: (str | None) = None,
    notes: (str | None) = None,
    tags: (Sequence[str] | None) = None,
    config: (dict[str, Any] | str | None) = None,
    config_exclude_keys: (list[str] | None) = None,
    config_include_keys: (list[str] | None) = None,
    allow_val_change: (bool | None) = None,
    group: (str | None) = None,
    job_type: (str | None) = None,
    mode: (Literal['online', 'offline', 'disabled'] | None) = None,
    force: (bool | None) = None,
    anonymous: (Literal['never', 'allow', 'must'] | None) = None,
    reinit: (bool | None) = None,
    resume: (bool | Literal['allow', 'never', 'must', 'auto'] | None) = None,
    resume_from: (str | None) = None,
    fork_from: (str | None) = None,
    save_code: (bool | None) = None,
    tensorboard: (bool | None) = None,
    sync_tensorboard: (bool | None) = None,
    monitor_gym: (bool | None) = None,
    settings: (Settings | dict[str, Any] | None) = None
) -> Run

MLトレーニングパイプラインでは、トレーニングスクリプトや評価スクリプトの最初にwandb.init()を追加することができます。それぞれの部分はW&BでのRunとしてトラックされます。

wandb.init()はバックグラウンドプロセスを立ち上げてRunにデータをログし、デフォルトで https://wandb.ai と同期して、リアルタイムで結果を見ることができます。

データをwandb.log()でログする前に、Runを開始するためにwandb.init()を呼び出します。データのログが終わったら、wandb.finish()を呼び出してRunを終了します。wandb.finish()を呼び出さない場合は、スクリプトが終了した時にRunが終了します。

wandb.init()の使い方や詳細な例については、ガイドとFAQをご覧ください。

例:

entityとプロジェクトを明示的に設定し、Runの名前を選択します:

import wandb

run = wandb.init(
    entity="geoff",
    project="capsules",
    name="experiment-2021-10-31",
)

# ... ここにトレーニングコードを記述 ...

run.finish()

config引数を使ってRunに関するメタデータを追加します:

import wandb

config = {"lr": 0.01, "batch_size": 32}
with wandb.init(config=config) as run:
    run.config.update({"architecture": "resnet", "depth": 34})

    # ... ここにトレーニングコードを記述 ...

wandb.init()をコンテキストマネージャとして使用することで、ブロックの終了時に自動的にwandb.finish()を呼び出すことができます。

2 - launch-library

クラス

class LaunchAgent: 指定されたrunキューをポーリングし、wandb Launch のためにrunを起動するLaunch エージェントクラス。

関数

launch(...): W&B ローンンチ 実験を開始します。

launch_add(...): W&B ローンンチ 実験をキューに追加します。source uri、jobまたはdocker_imageのいずれかを使用します。

2.1 - launch_add

W&B ローンチ実験をキューに追加します。ソース URI、ジョブ、または docker_image のいずれかを使用します。

launch_add(
    uri: Optional[str] = None,
    job: Optional[str] = None,
    config: Optional[Dict[str, Any]] = None,
    template_variables: Optional[Dict[str, Union[float, int, str]]] = None,
    project: Optional[str] = None,
    entity: Optional[str] = None,
    queue_name: Optional[str] = None,
    resource: Optional[str] = None,
    entry_point: Optional[List[str]] = None,
    name: Optional[str] = None,
    version: Optional[str] = None,
    docker_image: Optional[str] = None,
    project_queue: Optional[str] = None,
    resource_args: Optional[Dict[str, Any]] = None,
    run_id: Optional[str] = None,
    build: Optional[bool] = (False),
    repository: Optional[str] = None,
    sweep_id: Optional[str] = None,
    author: Optional[str] = None,
    priority: Optional[int] = None
) -> "public.QueuedRun"

例:

from wandb.sdk.launch import launch_add

project_uri = "https://github.com/wandb/examples"
params = {"alpha": 0.5, "l1_ratio": 0.01}
# W&B プロジェクトを実行し、ローカルホスト上で再現可能な Docker 環境を作成
api = wandb.apis.internal.Api()
launch_add(uri=project_uri, parameters=params)

2.2 - LaunchAgent

Launch エージェントクラスは、指定されたランキューをポーリングし、wandb Launch のために runs をローンチします。

LaunchAgent(
    api: Api,
    config: Dict[str, Any]
)

メソッド

check_sweep_state

ソースを表示

check_sweep_state(
    launch_spec, api
)

sweep のために run をローンチする前に sweep の状態を確認します。

fail_run_queue_item

ソースを表示

fail_run_queue_item(
    run_queue_item_id, message, phase, files=None
)

finish_thread_id

ソースを表示

finish_thread_id(
    thread_id, exception=None
)

しばらくの間、ジョブをリストから削除します。

get_job_and_queue

ソースを表示

get_job_and_queue()

initialized

ソースを表示

@classmethod
initialized() -> bool

エージェントが初期化されているかを返します。

loop

ソースを表示

loop()

ジョブをポーリングしてそれを実行するために無限ループします。

name

ソースを表示

@classmethod
name() -> str

エージェントの名前を返します。

pop_from_queue

ソースを表示

pop_from_queue(
    queue
)

ジョブとして実行するために run キューからアイテムを取り出します。

print_status

ソースを表示

print_status() -> None

エージェントの現在のステータスを表示します。

run_job

ソースを表示

run_job(
    job, queue, file_saver
)

プロジェクトをセットアップし、ジョブを実行します。

task_run_job

ソースを表示

task_run_job(
    launch_spec, job, default_config, api, job_tracker
)

update_status

ソースを表示

update_status(
    status
)

エージェントのステータスを更新します。

2.3 - ローンチ

W&B ローンンチ実験をローンンチする。

launch(
    api: Api,
    job: Optional[str] = None,
    entry_point: Optional[List[str]] = None,
    version: Optional[str] = None,
    name: Optional[str] = None,
    resource: Optional[str] = None,
    resource_args: Optional[Dict[str, Any]] = None,
    project: Optional[str] = None,
    entity: Optional[str] = None,
    docker_image: Optional[str] = None,
    config: Optional[Dict[str, Any]] = None,
    synchronous: Optional[bool] = (True),
    run_id: Optional[str] = None,
    repository: Optional[str] = None
) -> AbstractRun

例:

from wandb.sdk.launch import launch

job = "wandb/jobs/Hello World:latest"
params = {"epochs": 5}
# W&B プロジェクトを実行し、再現可能な Docker 環境を作成
# ローカルホストで
api = wandb.apis.internal.Api()
launch(api, job, parameters=params)

3 - run

wandbによってログに記録される計算の単位。通常、これは機械学習実験です。

Run(
    settings: Settings,
    config: (dict[str, Any] | None) = None,
    sweep_config: (dict[str, Any] | None) = None,
    launch_config: (dict[str, Any] | None) = None
) -> None

wandb.init()を使用してrunを作成します：

import wandb

run = wandb.init()

どのプロセスにも最大で1つだけアクティブなwandb.Runがあり、wandb.runとしてアクセス可能です：

import wandb

assert wandb.run is None

wandb.init()

assert wandb.run is not None

wandb.logでログに記録したものはすべてそのrunに送信されます。

同じスクリプトまたはノートブックで複数のrunを開始したい場合は、進行中のrunを終了する必要があります。Runはwandb.finishで終了するか、withブロック内で使用することで終了できます：

import wandb

wandb.init()
wandb.finish()

assert wandb.run is None

with wandb.init() as run:
    pass  # データをここでログに記録

assert wandb.run is None

wandb.initでrunを作成する方法についてはドキュメントを参照するか、 こちらのガイドをご覧ください。

分散トレーニングでは、ランク0のプロセスで単一のrunを作成してそのプロセスからのみ情報をログするか、各プロセスでrunを作成してそれぞれからログを取り、wandb.initのgroup引数で結果をグループ化することができます。W&Bを使用した分散トレーニングの詳細については、 こちらのガイドをご覧ください。

現在、wandb.Apiには並行するRunオブジェクトがあります。最終的にこれら2つのオブジェクトは統合される予定です。

メソッド

alert

ソースを見る

alert(
    title: str,
    text: str,
    level: (str | AlertLevel | None) = None,
    wait_duration: (int | float | timedelta | None) = None
) -> None

指定されたタイトルとテキストでアラートを開始します。

define_metric

ソースを見る

define_metric(
    name: str,
    step_metric: (str | wandb_metric.Metric | None) = None,
    step_sync: (bool | None) = None,
    hidden: (bool | None) = None,
    summary: (str | None) = None,
    goal: (str | None) = None,
    overwrite: (bool | None) = None
) -> wandb_metric.Metric

wandb.log()で記録されたメトリクスをカスタマイズします。

detach

ソースを見る

detach() -> None

display

ソースを見る

display(
    height: int = 420,
    hidden: bool = (False)
) -> bool

このrunをjupyterで表示します。

finish

ソースを見る

finish(
    exit_code: (int | None) = None,
    quiet: (bool | None) = None
) -> None

runを終了し、残りのデータをアップロードします。

W&B runの完了をマークし、すべてのデータがサーバーに同期されていることを確認します。 runの最終状態は、その終了条件と同期状態によって決まります。

Runの状態:

• Running: データをログしているおよび/またはハートビートを送信しているアクティブなrun。
• Crashed: 予期せずハートビートの送信を停止したrun。
• Finished: すべてのデータが同期されて正常に完了したrun（exit_code=0）。
• Failed: エラーで完了したrun（exit_code!=0）。

finish_artifact

ソースを見る

finish_artifact(
    artifact_or_path: (Artifact | str),
    name: (str | None) = None,
    type: (str | None) = None,
    aliases: (list[str] | None) = None,
    distributed_id: (str | None) = None
) -> Artifact

非最終アーティファクトをrunの出力として終了します。

同じdistributed IDでの後続の「アップサート」は新しいバージョンになります。

get_project_url

ソースを見る

get_project_url() -> (str | None)

runに関連付けられたW&BプロジェクトのURLを返します（存在する場合）。

オフラインrunはプロジェクトURLを持ちません。

get_sweep_url

ソースを見る

get_sweep_url() -> (str | None)

runに関連付けられたsweepのURLを返します（存在する場合）。

get_url

ソースを見る

get_url() -> (str | None)

W&B runのURLを返します（存在する場合）。

オフラインrunはURLを持ちません。

join

ソースを見る

join(
    exit_code: (int | None) = None
) -> None

finish()のための非推奨のエイリアス - 代わりにfinishを使用してください。

link_artifact

ソースを見る

link_artifact(
    artifact: Artifact,
    target_path: str,
    aliases: (list[str] | None) = None
) -> None

指定されたアートファクトをポートフォリオ（アーティストの昇格されたコレクション）にリンクします。

リンクされたアートファクトは、指定されたポートフォリオのUIに表示されます。

link_model

ソースを見る

link_model(
    path: StrPath,
    registered_model_name: str,
    name: (str | None) = None,
    aliases: (list[str] | None) = None
) -> None

モデルアーティファクトバージョンをログし、モデルレジストリで登録されたモデルにリンクします。

リンクされたモデルバージョンは、指定された登録モデルのUIに表示されます。

ステップ:

• ’name’モデルアーティファクトがログされているか確認します。そうであれば、‘path’にあるファイルに一致するアーティファクトバージョンを使用するか新しいバージョンをログします。そうでなければ、‘path’の下のファイルを新しいモデルアーティファクト’type’の’type’としてログします。
• ‘model-registry’プロジェクトに’registered_model_name’という名前の登録モデルが存在するか確認します。存在しない場合、‘registered_model_name’という名前の新しい登録モデルを作成します。
• モデルアーティファクト’name’のバージョンを登録モデル’registered_model_name’にリンクします。
• 新しくリンクされたモデルアーティファクトバージョンに’aliases’リストのエイリアスを添付します。

例:

run.link_model(
    path="/local/directory",
    registered_model_name="my_reg_model",
    name="my_model_artifact",
    aliases=["production"],
)

無効な使用法

run.link_model(
    path="/local/directory",
    registered_model_name="my_entity/my_project/my_reg_model",
    name="my_model_artifact",
    aliases=["production"],
)

run.link_model(
    path="/local/directory",
    registered_model_name="my_reg_model",
    name="my_entity/my_project/my_model_artifact",
    aliases=["production"],
)

log

ソースを見る

log(
    data: dict[str, Any],
    step: (int | None) = None,
    commit: (bool | None) = None,
    sync: (bool | None) = None
) -> None

runデータをアップロードします。

logを使用してrunからデータ（例えば、スカラー、画像、ビデオ、ヒストグラム、プロット、テーブルなど）をログに記録します。

ログ記録ガイドを参照し、 ライブの例、コードスニペット、ベストプラクティスなどを確認してください。

最も基本的な使用法はrun.log({"train-loss": 0.5, "accuracy": 0.9})です。 これは、損失と精度をrunの履歴に保存し、これらのメトリクスのsummaryの値を更新します。

ワークスペースでログしたデータをwandb.aiで可視化したり、自分でホストするW&Bアプリのインスタンスでローカルに可視化したり、データをエクスポートしてローカルで可視化、探索したり、例えば、Jupyter ノートブックで公開APIを使用して行うことができます。

ログした値はスカラーである必要はありません。任意のwandbオブジェクトのログがサポートされています。 例えば、run.log({"example": wandb.Image("myimage.jpg")})は、W&B UIにうまく表示される例の画像のログを記録します。 さまざまにサポートされているタイプについては、参照ドキュメントを参照するか、logging ガイドで、3D分子構造やセグメンテーションマスク、PR曲線、ヒストグラムの例を確認してください。 wandb.Tableを使用して構造化データをログできます。詳細については、テーブルログのガイドをご覧ください。

W&B UIは、メトリクスを名前に含むスラッシュ（/）を含むセクションに整理し、名前の最後のスラッシュ前のテキストでセクション名を使用します。例えば、次の例では、「train」と「validate」という2つのセクションがあります：

run.log(
    {
        "train/accuracy": 0.9,
        "train/loss": 30,
        "validate/accuracy": 0.8,
        "validate/loss": 20,
    }
)

サポートされているネストのレベルは1つのみです。run.log({"a/b/c": 1})は「a/b」という名前のセクションを生成します。

run.logは1秒に数回以上呼び出す目的には使用されていません。 最適なパフォーマンスのために、N回のイテレーションごとに一度ログを記録するか、複数のイテレーションにわたってデータを収集し、単一のステップでログを記録することをお勧めします。

W&Bステップ

基本的な使用法では、logを呼び出すたびに新しい「ステップ」が作成されます。 ステップは常に増加する必要があり、過去のステップにログを記録することはできません。

多くの場合、W&Bステップをタイムスタンプと同様に扱う方がトレーニングステップとして扱うより良いです。

# 例: X軸として使用する "epoch" メトリクスをログする方法。
run.log({"epoch": 40, "train-loss": 0.5})

define_metricも参照してください。

stepおよびcommitパラメータを使用して、同じステップにログを記録するために複数のlog呼び出しを使用することができます。 以下はすべて同等です：

# 通常の使用法：
run.log({"train-loss": 0.5, "accuracy": 0.8})
run.log({"train-loss": 0.4, "accuracy": 0.9})

# 自動インクリメントなしの暗黙のステップ：
run.log({"train-loss": 0.5}, commit=False)
run.log({"accuracy": 0.8})
run.log({"train-loss": 0.4}, commit=False)
run.log({"accuracy": 0.9})

# 明示的なステップ：
run.log({"train-loss": 0.5}, step=current_step)
run.log({"accuracy": 0.8}, step=current_step)
current_step += 1
run.log({"train-loss": 0.4}, step=current_step)
run.log({"accuracy": 0.9}, step=current_step)

例:

詳細でより多くの例は、 このログ記録ガイドをご覧ください。

基本的な使用法

import wandb

run = wandb.init()
run.log({"accuracy": 0.9, "epoch": 5})

インクリメンタルログ

import wandb

run = wandb.init()
run.log({"loss": 0.2}, commit=False)
# 別の場所でこのステップを報告する準備ができたとき：
run.log({"accuracy": 0.8})

ヒストグラム

import numpy as np
import wandb

# グラデーションをランダムに正規分布からサンプリング
gradients = np.random.randn(100, 100)
run = wandb.init()
run.log({"gradients": wandb.Histogram(gradients)})

NumPyから画像

import numpy as np
import wandb

run = wandb.init()
examples = []
for i in range(3):
    pixels = np.random.randint(low=0, high=256, size=(100, 100, 3))
    image = wandb.Image(pixels, caption=f"random field {i}")
    examples.append(image)
run.log({"examples": examples})

PILから画像

import numpy as np
from PIL import Image as PILImage
import wandb

run = wandb.init()
examples = []
for i in range(3):
    pixels = np.random.randint(
        low=0,
        high=256,
        size=(100, 100, 3),
        dtype=np.uint8,
    )
    pil_image = PILImage.fromarray(pixels, mode="RGB")
    image = wandb.Image(pil_image, caption=f"random field {i}")
    examples.append(image)
run.log({"examples": examples})

NumPyからビデオ

import numpy as np
import wandb

run = wandb.init()
# 軸 (time, channel, height, width)
frames = np.random.randint(
    low=0,
    high=256,
    size=(10, 3, 100, 100),
    dtype=np.uint8,
)
run.log({"video": wandb.Video(frames, fps=4)})

Matplotlibプロット

from matplotlib import pyplot as plt
import numpy as np
import wandb

run = wandb.init()
fig, ax = plt.subplots()
x = np.linspace(0, 10)
y = x * x
ax.plot(x, y)  # プロットy = x^2
run.log({"chart": fig})

PR曲線

import wandb

run = wandb.init()
run.log({"pr": wandb.plot.pr_curve(y_test, y_probas, labels)})

3Dオブジェクト

import wandb

run = wandb.init()
run.log(
    {
        "generated_samples": [
            wandb.Object3D(open("sample.obj")),
            wandb.Object3D(open("sample.gltf")),
            wandb.Object3D(open("sample.glb")),
        ]
    }
)

log_artifact

ソースを見る

log_artifact(
    artifact_or_path: (Artifact | StrPath),
    name: (str | None) = None,
    type: (str | None) = None,
    aliases: (list[str] | None) = None,
    tags: (list[str] | None) = None
) -> Artifact

アーティファクトをrunの出力として宣言します。

log_code

ソースを見る

log_code(
    root: (str | None) = ".",
    name: (str | None) = None,
    include_fn: (Callable[[str, str], bool] | Callable[[str], bool]) = _is_py_requirements_or_dockerfile,
    exclude_fn: (Callable[[str, str], bool] | Callable[[str], bool]) = filenames.exclude_wandb_fn
) -> (Artifact | None)

コードの現状をW&Bアーティファクトとして保存します。

デフォルトでは、現在のディレクトリを探索し、.pyで終わるすべてのファイルをログに記録します。

例:

基本的な使用法

run.log_code()

高度な使用法

run.log_code(
    "../",
    include_fn=lambda path: path.endswith(".py") or path.endswith(".ipynb"),
    exclude_fn=lambda path, root: os.path.relpath(path, root).startswith(
        "cache/"
    ),
)

log_model

ソースを見る

log_model(
    path: StrPath,
    name: (str | None) = None,
    aliases: (list[str] | None) = None
) -> None

‘path’内の内容をrunに含むモデルアーティファクトをログに記録し、runの出力としてマークします。

例:

run.log_model(
    path="/local/directory",
    name="my_model_artifact",
    aliases=["production"],
)

無効な使用法

run.log_model(
    path="/local/directory",
    name="my_entity/my_project/my_model_artifact",
    aliases=["production"],
)

mark_preempting

ソースを見る

mark_preempting() -> None

このrunを中断しているとマークします。

また、内部プロセスに即座にサーバーに報告するよう指示します。

project_name

ソースを見る

project_name() -> str

restore

ソースを見る

restore(
    name: str,
    run_path: (str | None) = None,
    replace: bool = (False),
    root: (str | None) = None
) -> (None | TextIO)

クラウドストレージから指定されたファイルをダウンロードします。

ファイルは現在のディレクトリまたはrunディレクトリに配置されます。 デフォルトでは、ローカルにまだ存在しない場合にのみファイルをダウンロードします。

save

ソースを見る

save(
    glob_str: (str | os.PathLike | None) = None,
    base_path: (str | os.PathLike | None) = None,
    policy: PolicyName = "live"
) -> (bool | list[str])

1つ以上のファイルをW&Bに同期させます。

相対的なパスは現在の作業ディレクトリに相対的です。

saveが呼び出された時点でUnix glob（例えば「myfiles/*」）が展開され、policyに関係なく新しいファイルは自動的にピックアップされることはありません。

saveを呼び出した時点でUnix glob（例えば"myfiles/*"）は、policyに関係なく展開されます。特に、新しいファイルは自動的に取得されません。

アップロードされるファイルのディレクトリ構造を制御するためにbase_pathを指定できます。これはglob_strの接頭辞であり、その下のディレクトリ構造は保持されます。例を通じて最適に理解できます：

wandb.save("these/are/myfiles/*")
# => run内の"these/are/myfiles/"フォルダにファイルを保存します。

wandb.save("these/are/myfiles/*", base_path="these")
# => run内の"are/myfiles/"フォルダにファイルを保存します。

wandb.save("/User/username/Documents/run123/*.txt")
# => run内の"run123/"フォルダにファイルを保存します。以下の注意を参照してください。

wandb.save("/User/username/Documents/run123/*.txt", base_path="/User")
# => run内の"username/Documents/run123/"フォルダにファイルを保存します。

wandb.save("files/*/saveme.txt")
# => 各 "saveme.txt" ファイルを "files/" の適切なサブディレクトリに保存します。

注意：絶対パスまたはglobが指定されbase_pathがない場合は、上記の例のように1つのディレクトリレベルが保持されます。

status

ソースを見る

status() -> RunStatus

内部バックエンドからの現在のrunの同期状態についての情報を取得します。

to_html

ソースを見る

to_html(
    height: int = 420,
    hidden: bool = (False)
) -> str

現在のrunを表示するiframeを含むHTMLを生成します。

unwatch

ソースを見る

unwatch(
    models: (torch.nn.Module | Sequence[torch.nn.Module] | None) = None
) -> None

PyTorchモデルのトポロジー、勾配、およびパラメータフックを削除します。

upsert_artifact

ソースを見る

upsert_artifact(
    artifact_or_path: (Artifact | str),
    name: (str | None) = None,
    type: (str | None) = None,
    aliases: (list[str] | None) = None,
    distributed_id: (str | None) = None
) -> Artifact

runの出力として、非最終化されたアーティファクトを宣言する（または追加）します。

注意：アーティファクトを最終化するためには、 run.finish_artifact()を呼び出す必要があります。 これは分散ジョブが同じアーティファクトにすべて貢献する必要がある場合に役立ちます。

use_artifact

ソースを見る

use_artifact(
    artifact_or_name: (str | Artifact),
    type: (str | None) = None,
    aliases: (list[str] | None) = None,
    use_as: (str | None) = None
) -> Artifact

runの入力としてアーティファクトを宣言します。

返されたオブジェクトでdownloadまたはfileを呼び出して、コンテンツをローカルに取得します。

use_model

ソースを見る

use_model(
    name: str
) -> FilePathStr

モデルアーティファクト’name’にログされたファイルをダウンロードします。

例:

run.use_model(
    name="my_model_artifact:latest",
)

run.use_model(
    name="my_project/my_model_artifact:v0",
)

run.use_model(
    name="my_entity/my_project/my_model_artifact:<digest>",
)

無効な使用法

run.use_model(
    name="my_entity/my_project/my_model_artifact",
)

watch

ソースを見る

watch(
    models: (torch.nn.Module | Sequence[torch.nn.Module]),
    criterion: (torch.F | None) = None,
    log: (Literal['gradients', 'parameters', 'all'] | None) = "gradients",
    log_freq: int = 1000,
    idx: (int | None) = None,
    log_graph: bool = (False)
) -> None

与えられたPyTorchのモデルにフックを設定して、勾配とモデルの計算グラフを監視します。

この関数は、トレーニング中にパラメータ、勾配、または両方を追跡することができます。 将来的には任意の機械学習モデルに対応するよう拡張されるべきです。

__enter__

ソースを見る

__enter__() -> Run

__exit__

ソースを見る

__exit__(
    exc_type: type[BaseException],
    exc_val: BaseException,
    exc_tb: TracebackType
) -> bool

4 - sweep

ハイパーパラメーター探索を初期化します。

sweep(
    sweep: Union[dict, Callable],
    entity: Optional[str] = None,
    project: Optional[str] = None,
    prior_runs: Optional[List[str]] = None
) -> str

機械学習モデルのコスト関数を最適化するハイパーパラメーターを見つけるために、さまざまな組み合わせをテストします。

返されるユニークな識別子 sweep_id をメモしてください。後のステップで sweep_id を sweep agent に提供します。

5 - wandb_ワークスペース

クラス

class reports: W&B レポート API をプログラムで操作するための Python ライブラリ。

class workspaces: W&B ワークスペース API をプログラムで操作するための Python ライブラリ。

5.1 - ワークスペース

module wandb_workspaces.workspaces

プログラムで W&B Workspace API を操作するための Python ライブラリ。

# インポート方法
import wandb_workspaces.workspaces as ws

# ワークスペースを作成する例
ws.Workspace(
     name="Example W&B Workspace",
     entity="entity", # ワークスペースを所有する entity
     project="project", # ワークスペースが関連付けられている project
     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()

class RunSettings

runset （左側のバー）内の run の設定。

属性:

• color (str): UI での run の色。hex (#ff0000), css color (red), または rgb (rgb(255, 0, 0)) を指定できる。
• disabled (bool): run が非アクティブであるかどうか（UI で目が閉じている）。デフォルトは False に設定されている。

class RunsetSettings

ワークスペース内の runset（run を含む左側のバー）の設定。

属性:

• query (str): runset をフィルターするためのクエリ（regex 式である可能性あり、次のパラメータを参照）。
• regex_query (bool): 上記のクエリが regex 式であるかどうかを制御する。デフォルトは False に設定されている。
• filters (LList[expr.FilterExpr]): runset に適用するフィルターのリスト。フィルターは AND で結合される。フィルターの作成については FilterExpr を参照。
• groupby (LList[expr.MetricType]): runset でグループ化するメトリクスのリスト。 Metric, Summary, Config, Tags, または KeysInfo に設定。
• order (LList[expr.Ordering]): runset に適用するメトリクスと順序のリスト。
• run_settings (Dict[str, RunSettings]): run の設定の辞書。キーは run の ID で、値は RunSettings オブジェクト。

class Section

ワークスペース内のセクションを表す。

属性:

• name (str): セクションの名前またはタイトル。
• panels (LList[PanelTypes]): セクション内のパネルの順序付きリスト。デフォルトでは、最初が左上で最後が右下。
• is_open (bool): セクションが開いているか閉じているか。デフォルトは閉じている。
• layout_settings (Literal[standard, custom]): セクション内のパネルレイアウトの設定。
• panel_settings: セクション内のすべてのパネルに適用されるパネルレベルの設定。 WorkspaceSettings の Section に似ている。

class SectionLayoutSettings

セクションのパネルレイアウト設定。通常、W&B App Workspace UI のセクションの右上に表示される。

属性:

• layout (Literal[standard, custom]): セクション内のパネルのレイアウト。 standard はデフォルトのグリッドレイアウトに従い、custom は個々のパネル設定で制御されるカスタムレイアウトを許可する。
• columns (int): 標準レイアウトの場合、レイアウト内の列数。デフォルトは 3。
• rows (int): 標準レイアウトの場合、レイアウト内の行数。デフォルトは 2。

class SectionPanelSettings

セクションのパネル設定。セクションの WorkspaceSettings に似ている。

ここで適用される設定は、より詳細なパネル設定で上書きされることがある。優先順位は: Section < Panel。

属性:

• x_axis (str): X 軸メトリック名の設定。デフォルトでは Step に設定。
• x_min Optional[float]: X 軸の最小値。
• x_max Optional[float]: X 軸の最大値。
• smoothing_type (Literal[’exponentialTimeWeighted’, ’exponential’, ‘gaussian’, ‘average’, ’none’]): すべてのパネルに適用されるスムージングタイプ。
• smoothing_weight (int): すべてのパネルに適用されるスムージングウエイト。

class Workspace

W&B ワークスペースを表し、セクション、設定、run セットの構成を含む。

属性:

• entity (str): このワークスペースが保存される entity（通常、ユーザーまたはチーム名）。
• project (str): このワークスペースが保存されるプロジェクト。
• name: ワークスペースの名前。
• sections (LList[Section]): ワークスペース内のセクションの順序付きリスト。最初のセクションはワークスペースの上部にある。
• settings (WorkspaceSettings): ワークスペースの設定。通常、UI のワークスペースの上部に表示される。
• runset_settings (RunsetSettings): ワークスペース内の run セット（run を含む左側のバー）の設定。

property url

W&B アプリ内のワークスペースへの URL。

classmethod from_url

from_url(url: str)

URL からワークスペースを取得。

method save

save()

現在のワークスペースを W&B に保存。

戻り値:

• Workspace: 保存された内部名と ID を持つ更新されたワークスペース。

method save_as_new_view

save_as_new_view()

現在のワークスペースを W&B に新しいビューとして保存。

戻り値:

• Workspace: 保存された内部名と ID を持つ更新されたワークスペース。

class WorkspaceSettings

ワークスペースの設定。通常、UI のワークスペースの上部に表示される。

このオブジェクトには、x 軸、スムージング、外れ値、パネル、ツールチップ、run、パネルクエリバーの設定が含まれる。

ここで適用される設定は、より詳細なセクションおよびパネル設定で上書きされることがある。優先順位は: Workspace < Section < Panel。

属性:

• x_axis (str): X 軸メトリック名の設定。
• x_min (Optional[float]): X 軸の最小値。
• x_max (Optional[float]): X 軸の最大値。
• smoothing_type (Literal['exponentialTimeWeighted', 'exponential', 'gaussian', 'average', 'none']): すべてのパネルに適用されるスムージングタイプ。
• smoothing_weight (int): すべてのパネルに適用されるスムージングウエイト。
• ignore_outliers (bool): すべてのパネルで外れ値を無視する。
• sort_panels_alphabetically (bool): すべてのセクションでパネルをアルファベット順にソート。
• group_by_prefix (Literal[first, last]): 最初または最大最後までのプレフィックスでパネルをグループ化する（first または last）。デフォルトは last に設定。
• remove_legends_from_panels (bool): すべてのパネルから凡例を削除。
• tooltip_number_of_runs (Literal[default, all, none]): ツールチップに表示する run の数。
• tooltip_color_run_names (bool): ツールチップで run 名を run セットに合わせて色付けするかどうか（True）あるいはしないか（False）。デフォルトは True に設定。
• max_runs (int): パネルごとに表示される run の最大数（run セットの最初の 10 件の run になる）。
• point_visualization_method (Literal[line, point, line_point]): 点の可視化メソッド。
• panel_search_query (str): パネル検索バーのクエリ（正規表現式である可能性あり）。
• auto_expand_panel_search_results (bool): パネル検索結果を自動拡張するかどうか。

5.2 - レポート

module wandb_workspaces.reports.v2

プログラムで W&B レポート API を操作するための Python ライブラリ。

import wandb_workspaces.reports.v2 as wr

report = wr.Report(
     entity="entity",
     project="project",
     title="An amazing title",
     description="A descriptive description.",
)

blocks = [
     wr.PanelGrid(
         panels=[
             wr.LinePlot(x="time", y="velocity"),
             wr.ScatterPlot(x="time", y="acceleration"),
         ]
     )
]

report.blocks = blocks
report.save()

class BarPlot

2Dバープロットを表示するパネルオブジェクト。

Attributes:

• title (Optional[str]): プロットの上部に表示されるテキスト。
• metrics (LList[MetricType]): orientation Literal[“v”, “h”]: バープロットの向き。垂直 (“v”) または水平 (“h”) を選択します。デフォルトは水平 (“h”)。
• range_x (Tuple[float | None, float | None]): x軸の範囲を指定するタプル。
• title_x (Optional[str]): x軸のラベル。
• title_y (Optional[str]): y軸のラベル。
• groupby (Optional[str]): W&Bプロジェクトにログされたメトリクスに基づいて run をグループ化します。このレポートは情報を取得します。
• groupby_aggfunc (Optional[GroupAgg]): 指定された関数で run を集計します。オプションには mean, min, max, median, sum, samples, または None が含まれます。
• groupby_rangefunc (Optional[GroupArea]): 範囲に基づいて run をグループ化します。オプションには minmax, stddev, stderr, none, samples, または None が含まれます。
• max_runs_to_show (Optional[int]): プロットに表示する最大 run 数。
• max_bars_to_show (Optional[int]): バープロットに表示する最大バー数。
• custom_expressions (Optional[LList[str]]): バープロットで使用されるカスタム式のリスト。
• legend_template (Optional[str]): 凡例のテンプレート。
• font_size (Optional[FontSize]): ラインプロットのフォントサイズ。オプションには small, medium, large, auto, または None が含まれます。
• line_titles (Optional[dict]): ラインのタイトル。キーがライン名で、値がタイトルです。
• line_colors (Optional[dict]): ラインの色。キーがライン名で、値が色です。

class BlockQuote

引用されたテキストのブロック。

Attributes:

• text (str): 引用ブロックのテキスト。

class CalloutBlock

強調されたテキストのブロック。

Attributes:

• text (str): 強調テキスト。

class CheckedList

チェックボックス付きの項目リスト。CheckedListItem を CheckedList 内に1つ以上追加します。

Attributes:

• items (LList[CheckedListItem]): CheckedListItem オブジェクトのリスト。

class CheckedListItem

チェックボックス付きのリストアイテム。CheckedList 内に1つ以上の CheckedListItem を追加します。

Attributes:

• text (str): リストアイテムのテキスト。
• checked (bool): チェックボックスがチェックされているかどうか。デフォルトは False。

class CodeBlock

コードのブロック。

Attributes:

• code (str): ブロック内のコード。
• language (Optional[Language]): コードの言語。指定された言語は構文強調表示に使われます。デフォルトは python。オプションには javascript, python, css, json, html, markdown, yaml が含まれます。

class CodeComparer

異なる2つの run 間のコードを比較するパネルオブジェクト。

Attributes:

• diff (Literal[‘split’, ‘unified’]): コードの差異を表示する方法。オプションには split と unified が含まれます。

class Config

run の設定オブジェクトにログされたメトリクス。設定オブジェクトは通常、run.config[name] = ... を使用するか、キーと値のペアを持つ設定として渡されてログされます。ここでキーがメトリクスの名前、値がメトリクスの値です。

Attributes:

• name (str): メトリクスの名前。

class CustomChart

カスタムチャートを表示するパネル。チャートは Weave クエリによって定義されます。

Attributes:

• query (dict): カスタムチャートを定義するクエリ。キーがフィールドの名前で、値がクエリです。
• chart_name (str): カスタムチャートのタイトル。
• chart_fields (dict): プロットの軸を定義するキーと値のペア。ここでキーはラベル、値はメトリクスです。
• chart_strings (dict): チャート内の文字列を定義するキーと値のペア。

classmethod from_table

from_table(
    table_name: str,
    chart_fields: dict = None,
    chart_strings: dict = None
)

テーブルからカスタムチャートを作成します。

Arguments:

• table_name (str): テーブルの名前。
• chart_fields (dict): チャートに表示するフィールド。
• chart_strings (dict): チャートに表示する文字列。

class Gallery

レポートと URL のギャラリーをレンダリングするブロック。

Attributes:

• items (List[Union[GalleryReport, GalleryURL]]): GalleryReport と GalleryURL オブジェクトのリスト。

class GalleryReport

ギャラリー内のレポートへの参照。

Attributes:

• report_id (str): レポートの ID。

class GalleryURL

外部リソースへの URL。

Attributes:

• url (str): リソースの URL。
• title (Optional[str]): リソースのタイトル。
• description (Optional[str]): リソースの説明。
• image_url (Optional[str]): 表示する画像の URL。

class GradientPoint

勾配内の点。

Attributes:

• color: 点の色。
• offset: 勾配内の点の位置。値は 0 から 100 の範囲であるべきです。

class H1

指定されたテキストを持つ H1 ヘッディング。

Attributes:

• text (str): ヘッディングのテキスト。
• collapsed_blocks (Optional[LList[“BlockTypes”]]): ヘッディングを折りたたんだときに表示されるブロック。

class H2

指定されたテキストを持つ H2 ヘッディング。

Attributes:

• text (str): ヘッディングのテキスト。
• collapsed_blocks (Optional[LList[“BlockTypes”]]): ヘッディングを折りたたんだときに表示される1つ以上のブロック。

class H3

指定されたテキストを持つ H3 ヘッディング。

Attributes:

• text (str): ヘッディングのテキスト。
• collapsed_blocks (Optional[LList[“BlockTypes”]]): ヘッディングを折りたたんだときに表示される1つ以上のブロック。

class Heading

class HorizontalRule

HTML の水平ライン。

class Image

画像をレンダリングするブロック。

Attributes:

• url (str): 画像の URL。
• caption (str): 画像のキャプション。キャプションは画像の下に表示されます。

class InlineCode

インラインコード。コードの後に改行文字を加えません。

Attributes:

• text (str): レポートに表示したいコード。

class InlineLatex

インライン LaTeX マークダウン。LaTeX マークダウンの後に改行文字を加えません。

Attributes:

• text (str): レポートに表示したい LaTeX マークダウン。

class LatexBlock

LaTeX テキストのブロック。

Attributes:

• text (str): LaTeX テキスト。

class Layout

レポート内のパネルのレイアウト。パネルのサイズと位置を調整します。

Attributes:

• x (int): パネルの x 位置。
• y (int): パネルの y 位置。
• w (int): パネルの幅。
• h (int): パネルの高さ。

class LinePlot

2D ラインプロットを持つパネルオブジェクト。

Attributes:

• title (Optional[str]): プロットの上部に表示されるテキスト。
• x (Optional[MetricType]): W&B プロジェクトにログされたメトリクスの名前。このレポートは情報を取得します。指定されたメトリクスは x 軸に使用されます。
• y (LList[MetricType]): W&B プロジェクトにログされた1つ以上のメトリクス。このレポートは情報を取得します。指定されたメトリクスは y 軸に使用されます。
• range_x (Tuple[float | None, float | None]): x軸の範囲を指定するタプル。
• range_y (Tuple[float | None, float | None]): y軸の範囲を指定するタプル。
• log_x (Optional[bool]): x 座標を底 10 の対数スケールでプロットします。
• log_y (Optional[bool]): y 座標を底 10 の対数スケールでプロットします。
• title_x (Optional[str]): x軸のラベル。
• title_y (Optional[str]): y軸のラベル。
• ignore_outliers (Optional[bool]): True に設定すると、外れ値をプロットしません。
• groupby (Optional[str]): W&B プロジェクトにログされたメトリクスに基づいて run をグループ化します。このレポートは情報を取得します。
• groupby_aggfunc (Optional[GroupAgg]): 指定された関数で run を集計します。オプションには mean, min, max, median, sum, samples, または None が含まれます。
• groupby_rangefunc (Optional[GroupArea]): 範囲に基づいて run をグループ化します。オプションには minmax, stddev, stderr, none, samples, または None が含まれます。
• smoothing_factor (Optional[float]): 平滑化タイプに適用する平滑化係数。許容する値は 0 から 1 の範囲です。
• smoothing_type (Optional[SmoothingType]): 指定された分布に基づいてフィルターを適用します。オプションには exponentialTimeWeighted, exponential, gaussian, average, または none が含まれます。
• smoothing_show_original (Optional[bool]): True に設定すると、元のデータを表示します。
• max_runs_to_show (Optional[int]): ラインプロットに表示する最大 run 数。
• custom_expressions (Optional[LList[str]]): データに適用するカスタム式。
• plot_type (Optional[LinePlotStyle]): 生成するラインプロットのタイプ。オプションには line, stacked-area, または pct-area が含まれます。
• font_size (Optional[FontSize]): ラインプロットのフォントサイズ。オプションには small, medium, large, auto, または None が含まれます。
• legend_position (Optional[LegendPosition]): 凡例を配置する場所。オプションには north, south, east, west, または None が含まれます。
• legend_template (Optional[str]): 凡例のテンプレート。
• aggregate (Optional[bool]): True に設定すると、データを集計します。
• xaxis_expression (Optional[str]): x軸の表現。
• legend_fields (Optional[LList[str]]): 凡例に含めるフィールド。

class Link

URL へのリンク。

Attributes:

• text (Union[str, TextWithInlineComments]): リンクのテキスト。
• url (str): リンクが指す URL。

class MarkdownBlock

マークダウンテキストのブロック。一般的なマークダウンサクジを使用してテキストを書くのに便利です。

Attributes:

• text (str): マークダウンテキスト。

class MarkdownPanel

マークダウンをレンダリングするパネル。

Attributes:

• markdown (str): マークダウンパネルに表示したいテキスト。

class MediaBrowser

メディアファイルをグリッドレイアウトで表示するパネル。

Attributes:

• num_columns (Optional[int]): グリッドの列数。
• media_keys (LList[str]): メディアファイルに対応するメディアキーのリスト。

class Metric

プロジェクトにログされたメトリクスをレポートに表示する。

Attributes:

• name (str): メトリクスの名前。

class OrderBy

並び替えに使用するメトリクス。

Attributes:

• name (str): メトリクスの名前。
• ascending (bool): 昇順にソートするかどうか。デフォルトは False に設定されています。

class OrderedList

番号付きリストの項目リスト。

Attributes:

• items (LList[str]): OrderedListItem オブジェクトのリスト。

class OrderedListItem

順序付きリストの項目。

Attributes:

• text (str): リストアイテムのテキスト。

class P

テキストの段落。

Attributes:

• text (str): 段落のテキスト。

class Panel

パネルグリッドで可視化を表示するパネル。

Attributes:

• layout (Layout): Layout オブジェクト。

class PanelGrid

runset とパネルで構成されるグリッド。runset とパネルはそれぞれ Runset と Panel オブジェクトで追加します。

利用可能なパネル:

• LinePlot, ScatterPlot, BarPlot, ScalarChart, CodeComparer, ParallelCoordinatesPlot, ParameterImportancePlot, RunComparer, MediaBrowser, MarkdownPanel, CustomChart, WeavePanel, WeavePanelSummaryTable, WeavePanelArtifactVersionedFile

Attributes:

• runsets (LList[“Runset”]): Runset オブジェクトのリスト。
• panels (LList[“PanelTypes”]): Panel オブジェクトのリスト。
• active_runset (int): runset 内で表示したい run の数。デフォルトは 0 に設定されています。
• custom_run_colors (dict): run の名前をキーに指定し、16進値の色を値として指定するキーと値のペア。

class ParallelCoordinatesPlot

並列座標プロットを表示するパネルオブジェクト。

Attributes:

• columns (LList[ParallelCoordinatesPlotColumn]): ParallelCoordinatesPlotColumn オブジェクトのリスト。
• title (Optional[str]): プロットの上部に表示されるテキスト。
• gradient (Optional[LList[GradientPoint]]): 勾配ポイントのリスト。
• font_size (Optional[FontSize]): ラインプロットのフォントサイズ。オプションには small, medium, large, auto, または None が含まれます。

class ParallelCoordinatesPlotColumn

並列座標プロット内の列。指定された metric の順序が並列軸 (x軸) の順序を決定します。

Attributes:

• metric (str | Config | SummaryMetric): W&B プロジェクトにログされたメトリクスの名前。このレポートは情報を取得します。
• display_name (Optional[str]): メトリクスの表示名。
• inverted (Optional[bool]): メトリクスを反転するかどうか。
• log (Optional[bool]): メトリクスに対数変換を適用するかどうか。

class ParameterImportancePlot

各ハイパーパラメーターが選択されたメトリクスの予測にどれほど重要かを示すパネル。

Attributes:

• with_respect_to (str): パラメータの重要度を比較したいメトリクス。一般的なメトリクスにはロス、精度などが含まれます。指定されたメトリクスはプロジェクト内でログされる必要があります。このレポートは情報を取得します。

class Report

W&B レポートを表すオブジェクト。返されたオブジェクトの blocks 属性を使用してレポートをカスタマイズします。レポートオブジェクトは自動的に保存されません。save() メソッドを使用して変更を保存してください。

Attributes:

• project (str): 読み込む W&B プロジェクトの名前。指定されたプロジェクトはレポートの URL に表示されます。
• entity (str): レポートを所有する W&B エンティティ。エンティティはレポートの URL に表示されます。
• title (str): レポートのタイトル。タイトルはレポートのトップに H1 ヘッディングとして表示されます。
• description (str): レポートの説明。説明はレポートのタイトルの下に表示されます。
• blocks (LList[BlockTypes]): HTML タグ、プロット、グリッド、runset などのリスト。
• width (Literal[‘readable’, ‘fixed’, ‘fluid’]): レポートの幅。オプションには ‘readable’, ‘fixed’, ‘fluid’ が含まれます。

property url

レポートがホストされている URL。レポート URL は https://wandb.ai/{entity}/{project_name}/reports/ で構成されます。ここで {entity} と {project_name} はそれぞれレポートが所属するエンティティとプロジェクトの名前です。

classmethod from_url

from_url(url: str, as_model: bool = False)

現在の環境にレポートを読み込みます。レポートがホストされている URL を渡します。

Arguments:

• url (str): レポートがホストされている URL。
• as_model (bool): True に設定すると、レポートオブジェクトの代わりにモデルオブジェクトが返されます。デフォルトは False に設定されています。

method save

save(draft: bool = False, clone: bool = False)

レポートオブジェクトに加えた変更を保存します。

method to_html

to_html(height: int = 1024, hidden: bool = False) → str

このレポートを表示する iframe を含む HTML を生成します。通常、Python ノートブック内で使用されます。

Arguments:

• height (int): iframe の高さ。
• hidden (bool): True に設定すると、iframe を非表示にします。デフォルトは False に設定されています。

class RunComparer

プロジェクトから引き出された情報で、異なる run 間のメトリクスを比較するパネル。

Attributes:

• diff_only (Optional[Literal[“split”, True]]): プロジェクト内の run 間の差異のみを表示します。W&B レポート UI ではこの機能のオン/オフを切り替えることができます。

class Runset

パネルグリッドに表示する run のセット。

Attributes:

• entity (str): run が保存されているプロジェクトを所有したり、正しい権限を持つエンティティ。
• project (str): run が保存されているプロジェクトの名前。
• name (str): run セットの名前。デフォルトで Run set に設定されています。
• query (str): run をフィルタリングするためのクエリ文字列。
• filters (Optional[str]): run をフィルタリングするためのフィルタ文字列。
• groupby (LList[str]): グループ化するメトリクス名のリスト。
• order (LList[OrderBy]): ソートするための OrderBy オブジェクトのリスト。
• custom_run_colors (LList[OrderBy]): run ID を色にマッピングする辞書。

class RunsetGroup

runset のグループを表示する UI エレメント。

Attributes:

• runset_name (str): runset の名前。
• keys (Tuple[RunsetGroupKey, …]): グループ化するためのキー。グループ化するために1つ以上の RunsetGroupKey オブジェクトを渡します。

class RunsetGroupKey

メトリクスタイプと値によって runset をグループ化します。RunsetGroup の一部として動作します。メトリクスタイプとグループ化する値をキーと値のペアとして指定します。

Attributes:

• key (Type[str] | Type[Config] | Type[SummaryMetric] | Type[Metric]): グループ化するメトリクスタイプ。
• value (str): グループ化するメトリクスの値。

class ScalarChart

スカラーグラフを表示するパネルオブジェクト。

Attributes:

• title (Optional[str]): プロットの上部に表示されるテキスト。
• metric (MetricType): W&B プロジェクトにログされたメトリクスの名前。このレポートは情報を取得します。
• groupby_aggfunc (Optional[GroupAgg]): 指定された関数で run を集計します。オプションには mean, min, max, median, sum, samples, または None が含まれます。
• groupby_rangefunc (Optional[GroupArea]): 範囲に基づいて run をグループ化します。オプションには minmax, stddev, stderr, none, samples, または None が含まれます。
• custom_expressions (Optional[LList[str]]): スカラーチャートで使用されるカスタム式のリスト。
• legend_template (Optional[str]): 凡例のテンプレート。
• font_size (Optional[FontSize]): ラインプロットのフォントサイズ。オプションには small, medium, large, auto, または None が含まれます。

class ScatterPlot

2D または 3D 散布図を表示するパネルオブジェクト。

Arguments:

• title (Optional[str]): プロットの上部に表示されるテキスト。
• x (Optional[SummaryOrConfigOnlyMetric]): W&B プロジェクトにログされたメトリクスの名前。このレポートは情報を取得します。指定されたメトリクスは x 軸に使用されます。
• y (Optional[SummaryOrConfigOnlyMetric]): W&B プロジェクトにログされた1つ以上のメトリクス。このレポートは情報を取得します。指定されたメトリクスは y 軸にプロットされます。
• range_x (Tuple[float | None, float | None]): x軸の範囲を指定するタプル。
• range_y (Tuple[float | None, float | None]): y軸の範囲を指定するタプル。
• log_x (Optional[bool]): x 座標を底 10 の対数スケールでプロットします。
• log_y (Optional[bool]): y 座標を底 10 の対数スケールでプロットします。
• legend_template (Optional[str]): 凡例の形式を指定する文字列。
• gradient (Optional[LList[GradientPoint]]): プロットの色勾配を指定する勾配ポイントのリスト。
• font_size (Optional[FontSize]): ラインプロットのフォントサイズ。オプションには small, medium, large, auto, または None が含まれます。
• regression (Optional[bool]): True に設定すると、散布図に回帰直線をプロットします。

class SoundCloud

SoundCloud プレーヤーをレンダリングするブロック。

Attributes:

• html (str): SoundCloud プレーヤーを埋め込むための HTML コード。

class Spotify

Spotify プレーヤーをレンダリングするブロック。

Attributes:

• spotify_id (str): トラックまたはプレイリストの Spotify ID。

class SummaryMetric

レポート内に表示するサマリメトリクス。

Attributes:

• name (str): メトリクスの名前。

class TableOfContents

H1, H2, H3 の HTML ブロックを使用して指定されたセクションとサブセクションのリストを含むブロック。

class TextWithInlineComments

インラインコメント付きのテキストブロック。

Attributes:

• text (str): テキストブロックのテキスト。

class Twitter

Twitter フィードを表示するブロック。

Attributes:

• html (str): Twitter フィードを表示するための HTML コード。

class UnorderedList

箇条書きリストの項目リスト。

Attributes:

• items (LList[str]): UnorderedListItem オブジェクトのリスト。

class UnorderedListItem

順序のないリストの項目。

Attributes:

• text (str): リストアイテムのテキスト。

class Video

ビデオをレンダリングするブロック。

Attributes:

• url (str): ビデオの URL。

class WeaveBlockArtifact

W&B にログされたアーティファクトを示すブロック。クエリは次の形式を取ります。

project('entity', 'project').artifact('artifact-name')

API 名内の “Weave” の用語は、LLM を追跡および評価するために使用される W&B Weave ツールキットを指していません。

Attributes:

• entity (str): アーティファクトが保存されているプロジェクトを所有するか、適切な権限を持つエンティティ。
• project (str): アーティファクトが保存されているプロジェクト。
• artifact (str): 取得するアーティファクトの名前。
• tab (Literal[“overview”, “metadata”, “usage”, “files”, “lineage”]): アーティファクトパネルに表示するタブ。

class WeaveBlockArtifactVersionedFile

バージョン化されたファイルを W&B アーティファクトにログしたことを示すブロック。クエリは次の形式を取ります。

project('entity', 'project').artifactVersion('name', 'version').file('file-name')

API 名内の “Weave” の用語は、LLM を追跡および評価するために使用される W&B Weave ツールキットを指していません。

Attributes:

• entity (str): アーティファクトが保存されているプロジェクトを所有するか、適切な権限を持つエンティティ。
• project (str): アーティファクトが保存されているプロジェクト。
• artifact (str): 取得するアーティファクトの名前。
• version (str): 取得するアーティファクトのバージョン。
• file (str): 取得するアーティファクト内に保存されているファイルの名前。

class WeaveBlockSummaryTable

W&B にログされた W&B テーブル、pandas DataFrame、プロット、またはその他の値を表示するブロック。クエリは次の形式を取ります。

project('entity', 'project').runs.summary['value']

API 名内の “Weave” の用語は、LLM を追跡および評価するために使用される W&B Weave ツールキットを指していません。

Attributes:

• entity (str): 値がログされたプロジェクトを所有するか、適切な権限を持つエンティティ。
• project (str): 値がログされたプロジェクト。
• table_name (str): テーブル、DataFrame、プロット、または値の名前。

class WeavePanel

クエリを使用してカスタムコンテンツを表示するための空のクエリパネル。

API 名内の “Weave” の用語は、LLM を追跡および評価するために使用される W&B Weave ツールキットを指していません。

class WeavePanelArtifact

W&B にログされたアーティファクトを示すパネル。

API 名内の “Weave” の用語は、LLM を追跡および評価するために使用される W&B Weave ツールキットを指していません。

Attributes:

• artifact (str): 取得するアーティファクトの名前。
• tab (Literal[“overview”, “metadata”, “usage”, “files”, “lineage”]): アーティファクトパネルに表示するタブ。

class WeavePanelArtifactVersionedFile

バージョンのあるファイルを W&B アーティファクトにログしたことを示すパネル。

project('entity', 'project').artifactVersion('name', 'version').file('file-name')

API 名内の “Weave” の用語は、LLM を追跡および評価するために使用される W&B Weave ツールキットを指していません。

Attributes:

• artifact (str): 取得するアーティファクトの名前。
• version (str): 取得するアーティファクトのバージョン。
• file (str): 取得するアーティファクト内に保存されているファイルの名前。

class WeavePanelSummaryTable

W&B にログされた W&B テーブル、pandas DataFrame、プロット、またはその他の値を表示するパネル。クエリは次の形式を取ります。

runs.summary['value']

API 名内の “Weave” の用語は、LLM を追跡および評価するために使用される W&B Weave ツールキットを指していません。

Attributes:

• table_name (str): テーブル、DataFrame、プロット、または値の名前。

6 - watch

指定された PyTorch モデルにフックし、勾配やモデルの計算グラフを監視します。

watch(
    models: (torch.nn.Module | Sequence[torch.nn.Module]),
    criterion: (torch.F | None) = None,
    log: (Literal['gradients', 'parameters', 'all'] | None) = "gradients",
    log_freq: int = 1000,
    idx: (int | None) = None,
    log_graph: bool = (False)
) -> None

この関数はトレーニング中にパラメータと勾配、またはその両方を追跡できます。将来的には任意の機械学習モデルをサポートするように拡張されるべきです。

7 - アーティファクト

データセットとモデルのバージョン管理のための柔軟で軽量なビルディングブロック。

Artifact(
    name: str,
    type: str,
    description: (str | None) = None,
    metadata: (dict[str, Any] | None) = None,
    incremental: bool = (False),
    use_as: (str | None) = None
) -> None

空の W&B Artifact を構築します。アーティファクトの内容を add で始まるメソッドを用いて追加してください。すべてのファイルがそろったら wandb.log_artifact() を呼び出してログ化します。

メソッド

add

ソースを表示

add(
    obj: WBValue,
    name: StrPath,
    overwrite: bool = (False)
) -> ArtifactManifestEntry

wandb.WBValue obj をアーティファクトに追加します。

add_dir

ソースを表示

add_dir(
    local_path: str,
    name: (str | None) = None,
    skip_cache: (bool | None) = (False),
    policy: (Literal['mutable', 'immutable'] | None) = "mutable"
) -> None

ローカルディレクトリーをアーティファクトに追加します。

add_file

ソースを表示

add_file(
    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)
) -> ArtifactManifestEntry

ローカルファイルをアーティファクトに追加します。

add_reference

ソースを表示

add_reference(
    uri: (ArtifactManifestEntry | str),
    name: (StrPath | None) = None,
    checksum: bool = (True),
    max_objects: (int | None) = None
) -> Sequence[ArtifactManifestEntry]

URI によって示される参照をアーティファクトに追加します。

アーティファクトにファイルやディレクトリを追加する場合と異なり、参照は W&B にアップロードされません。詳細は、Track external files を参照してください。

デフォルトでは、以下のスキームがサポートされています:

• http(s): ファイルのサイズとダイジェストはサーバーから返された Content-Length と ETag レスポンスヘッダによって推測されます。
• s3: チェックサムとサイズはオブジェクトメタデータから取得されます。バケットバージョン管理が有効な場合、バージョン ID も追跡されます。
• gs: チェックサムとサイズはオブジェクトメタデータから取得されます。バケットバージョン管理が有効な場合、バージョン ID も追跡されます。
• https, *.blob.core.windows.net (Azure) ドメイン: チェックサムとサイズはブロブメタデータから取得されます。ストレージアカウントのバージョン管理が有効な場合、バージョン ID も追跡されます。
• file: チェックサムとサイズはファイルシステムから取得されます。このスキームは、アップロードする必要はないが追跡したいファイルを含む NFS シェアや他の外部マウントボリュームを持っている場合に便利です。

その他のスキームについては、ダイジェストは URI のハッシュとして生成され、サイズは空欄のままです。

checkout

ソースを表示

checkout(
    root: (str | None) = None
) -> str

指定されたルートディレクトリをアーティファクトの内容に置き換えます。

警告: root に含まれているがアーティファクトに含まれていないすべてのファイルは削除されます。

delete

ソースを表示

delete(
    delete_aliases: bool = (False)
) -> None

アーティファクトおよびそのファイルを削除します。

リンクされたアーティファクト（すなわち、ポートフォリオコレクションのメンバー）に対して呼び出された場合、リンクのみが削除され、元のアーティファクトには影響を与えません。

download

ソースを表示

download(
    root: (StrPath | None) = None,
    allow_missing_references: bool = (False),
    skip_cache: (bool | None) = None,
    path_prefix: (StrPath | None) = None
) -> FilePathStr

アーティファクトの内容を指定されたルートディレクトリにダウンロードします。

root 内の既存ファイルは変更されません。 root の内容をアーティファクトと完全に一致させたい場合は、download を呼び出す前に root を明示的に削除してください。

file

ソースを表示

file(
    root: (str | None) = None
) -> StrPath

指定した root のディレクトリに単一のファイルアーティファクトをダウンロードします。

files

ソースを表示

files(
    names: (list[str] | None) = None,
    per_page: int = 50
) -> ArtifactFiles

このアーティファクトに保存されているすべてのファイルを反復処理します。

finalize

ソースを表示

finalize() -> None

アーティファクトバージョンを確定します。

一度確定されたアーティファクトバージョンは、特定のアーティファクトバージョンとしてログされるため、変更できません。新しいデータをアーティファクトに記録するには、新しいアーティファクトバージョンを作成してください。アーティファクトは、log_artifact を使用してログ化すると自動的に確定されます。

get

ソースを表示

get(
    name: str
) -> (WBValue | None)

アーティファクト相対 name に配置されている WBValue オブジェクトを取得します。

get_added_local_path_name

ソースを表示

get_added_local_path_name(
    local_path: str
) -> (str | None)

ローカルファイルシステムパスによって追加されたファイルのアーティファクト相対名を取得します。

get_entry

ソースを表示

get_entry(
    name: StrPath
) -> ArtifactManifestEntry

指定した名前のエントリを取得します。

get_path

ソースを表示

get_path(
    name: StrPath
) -> ArtifactManifestEntry

非推奨。get_entry(name) を使用してください。

is_draft

ソースを表示

is_draft() -> bool

アーティファクトが保存されていないかをチェックします。

Returns: Boolean. False はアーティファクトが保存された場合。True はアーティファクトが保存されていない場合。

json_encode

ソースを表示

json_encode() -> dict[str, Any]

アーティファクトを JSON 形式にエンコードして返します。

link

ソースを表示

link(
    target_path: str,
    aliases: (list[str] | None) = None
) -> None

このアーティファクトをポートフォリオ（プロモートされたアーティファクトのコレクション）にリンクします。

logged_by

ソースを表示

logged_by() -> (Run | None)

元々アーティファクトをログした W&B run を取得します。

new_draft

ソースを表示

new_draft() -> Artifact

このコミット済みのアーティファクトと同じ内容の新しいドラフトアーティファクトを作成します。

既存のアーティファクトを修正すると、新しいアーティファクトバージョンである「インクリメンタルアーティファクト」が作成されます。返されたアーティファクトは拡張または修正され、新しいバージョンとしてログに記録できます。

new_file

ソースを表示

@contextlib.contextmanager
new_file(
    name: str,
    mode: str = "x",
    encoding: (str | None) = None
) -> Iterator[IO]

新しい一時ファイルを開いてアーティファクトに追加します。

remove

ソースを表示

remove(
    item: (StrPath | ArtifactManifestEntry)
) -> None

アイテムをアーティファクトから削除します。

save

ソースを表示

save(
    project: (str | None) = None,
    settings: (wandb.Settings | None) = None
) -> None

アーティファクトに加えた変更を永続化します。

現在 run にいる場合、その run はこのアーティファクトをログに記録します。run にいない場合、アーティファクトを追跡するために “auto” タイプの run が作成されます。

unlink

ソースを表示

unlink() -> None

このアーティファクトが現在ポートフォリオのメンバーである場合、それを解除します（プロモートされたアーティファクトのコレクション）。

used_by

ソースを表示

used_by() -> list[Run]

このアーティファクトを使用した run のリストを取得します。

verify

ソースを表示

verify(
    root: (str | None) = None
) -> None

アーティファクトの内容がマニフェストと一致するかを確認します。

ディレクトリ内のすべてのファイルはチェックサムが計算され、チェックサムはアーティファクトのマニフェストと照合されます。参照は確認されません。

wait

ソースを表示

wait(
    timeout: (int | None) = None
) -> Artifact

必要であれば、このアーティファクトがログの終了を待ちます。

__getitem__

ソースを表示

__getitem__(
    name: str
) -> (WBValue | None)

アーティファクト相対 name に配置されている WBValue オブジェクトを取得します。

__setitem__

ソースを表示

__setitem__(
    name: str,
    item: WBValue
) -> ArtifactManifestEntry

item をアーティファクトの name パスに追加します。

8 - インポート＆エクスポート API

クラス

class Api: wandb サーバーをクエリするために使用されます。

class File: File は wandb によって保存されたファイルに関連付けられているクラスです。

class Files: File オブジェクトの反復可能なコレクション。

class Job

class Project: プロジェクトは、run の名前空間です。

class Projects: Project オブジェクトの反復可能なコレクション。

class QueuedRun: entity と project に関連付けられた単一のキューされた run。run = queued_run.wait_until_running() または run = queued_run.wait_until_finished() を呼び出して run にアクセスします。

class Run: entity と project に関連付けられた単一の run。

class RunQueue

class Runs: プロジェクトとオプションのフィルタに関連付けられたいくつかの run の反復可能なコレクション。

class Sweep: sweep に関連付けられた一連の runs。

8.1 - Api API (Application Programming Interface) は、プログラム間でデータや機能をやり取りするためのインターフェースを提供します。W&B API は、ユーザーがwandb を通じて**Projects**、**Entities**、**Runs**などのデータにアクセスし、管理することを可能にします。このAPIにより、**Experiments**の追跡や**Reports**の共有を自動化できます。W&B APIはPythonを含むさまざまなプログラミング言語で利用可能です。これにより、カスタムスクリプトの作成や他のツールとの統合が簡単になります。APIの使用方法に関する詳細な情報は、[API documentation](https://wandb.ai)を参照してください。

wandb サーバーをクエリするために使用されます。

Api(
    overrides: Optional[Dict[str, Any]] = None,
    timeout: Optional[int] = None,
    api_key: Optional[str] = None
) -> None

例:

最も一般的な初期化方法

>>> wandb.Api()

メソッド

artifact

ソースを表示

artifact(
    name: str,
    type: Optional[str] = None
)

project/name または entity/project/name の形式でパスを解析することにより、単一のアーティファクトを返します。

注意:

このメソッドは外部利用のみを目的としています。wandb リポジトリコード内で api.artifact() を呼び出さないでください。

artifact_collection

ソースを表示

artifact_collection(
    type_name: str,
    name: str
) -> "public.ArtifactCollection"

タイプと entity/project/name の形式でパスを解析することにより、単一のアーティファクトコレクションを返します。

artifact_collection_exists

ソースを表示

artifact_collection_exists(
    name: str,
    type: str
) -> bool

指定されたプロジェクトとエンティティ内にアーティファクトコレクションが存在するかどうかを返します。

artifact_collections

ソースを表示

artifact_collections(
    project_name: str,
    type_name: str,
    per_page: Optional[int] = 50
) -> "public.ArtifactCollections"

一致するアーティファクトコレクションのコレクションを返します。

artifact_exists

ソースを表示

artifact_exists(
    name: str,
    type: Optional[str] = None
) -> bool

指定されたプロジェクトとエンティティ内にアーティファクトバージョンが存在するかどうかを返します。

artifact_type

ソースを表示

artifact_type(
    type_name: str,
    project: Optional[str] = None
) -> "public.ArtifactType"

一致する ArtifactType を返します。

artifact_types

ソースを表示

artifact_types(
    project: Optional[str] = None
) -> "public.ArtifactTypes"

一致するアーティファクトタイプのコレクションを返します。

artifact_versions

ソースを表示

artifact_versions(
    type_name, name, per_page=50
)

非推奨、代わりに artifacts(type_name, name) を使用してください。

artifacts

ソースを表示

artifacts(
    type_name: str,
    name: str,
    per_page: Optional[int] = 50,
    tags: Optional[List[str]] = None
) -> "public.Artifacts"

指定されたパラメータから Artifacts コレクションを返します。

create_project

ソースを表示

create_project(
    name: str,
    entity: str
) -> None

新しいプロジェクトを作成します。

create_run

ソースを表示

create_run(
    *,
    run_id: Optional[str] = None,
    project: Optional[str] = None,
    entity: Optional[str] = None
) -> "public.Run"

新しい run を作成します。

create_run_queue

ソースを表示

create_run_queue(
    name: str,
    type: "public.RunQueueResourceType",
    entity: Optional[str] = None,
    prioritization_mode: Optional['public.RunQueuePrioritizationMode'] = None,
    config: Optional[dict] = None,
    template_variables: Optional[dict] = None
) -> "public.RunQueue"

新しい run キュー (launch) を作成します。

create_team

ソースを表示

create_team(
    team, admin_username=None
)

新しいチームを作成します。

create_user

ソースを表示

create_user(
    email, admin=(False)
)

新しいユーザーを作成します。

flush

ソースを表示

flush()

ローカルキャッシュをフラッシュします。

API オブジェクトは run のローカルキャッシュを保持するため、スクリプトを実行中に run の状態が変更される可能性がある場合、api.flush() を使用してローカルキャッシュをクリアし、run に関連付けられた最新の値を取得します。

from_path

ソースを表示

from_path(
    path
)

パスから run、sweep、プロジェクト、またはレポートを返します。

例:

project = api.from_path("my_project")
team_project = api.from_path("my_team/my_project")
run = api.from_path("my_team/my_project/runs/id")
sweep = api.from_path("my_team/my_project/sweeps/id")
report = api.from_path("my_team/my_project/reports/My-Report-Vm11dsdf")

job

ソースを表示

job(
    name: Optional[str],
    path: Optional[str] = None
) -> "public.Job"

指定されたパラメーターから Job を返します。

list_jobs

ソースを表示

list_jobs(
    entity: str,
    project: str
) -> List[Dict[str, Any]]

指定されたエンティティとプロジェクトに対して、利用可能なジョブのリストを返します。

project

ソースを表示

project(
    name: str,
    entity: Optional[str] = None
) -> "public.Project"

指定された名前 (および指定された場合はエンティティ) の Project を返します。

projects

ソースを表示

projects(
    entity: Optional[str] = None,
    per_page: Optional[int] = 200
) -> "public.Projects"

指定されたエンティティのプロジェクトを取得します。

queued_run

ソースを表示

queued_run(
    entity, project, queue_name, run_queue_item_id, project_queue=None,
    priority=None
)

パスに基づいて単一のキューされた run を返します。

entity/project/queue_id/run_queue_item_id の形式のパスを解析します。

registries

ソースを表示

registries(
    organization: Optional[str] = None,
    filter: Optional[Dict[str, Any]] = None
) -> Registries

レジストリのイテレータを返します。

イテレータを使用して、組織のレジストリ内のレジストリ、コレクション、またはアーティファクトバージョンを検索およびフィルタリングします。

例:

“model” を含む名前のすべてのレジストリを見つけます。

import wandb

api = wandb.Api()  # エンティティが複数の組織に属する場合、組織を指定します。
api.registries(filter={"name": {"$regex": "model"}})