これは、このセクションの複数ページの印刷可能なビューです。印刷するには、ここをクリックしてください.

参照

Weights & Biases API に関する生成されたドキュメント

1: JavaScript ライブラリ

2: Python ライブラリ

2.1: init
2.2: launch-library

2.2.1: launch_add
2.2.2: LaunchAgent
2.2.3: ローンチ

2.3: run
2.4: sweep
2.5: wandb_ワークスペース

2.5.1: ワークスペース
2.5.2: レポート

2.6: watch
2.7: アーティファクト
2.8: インポート＆エクスポート API

2.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)を参照してください。
2.8.2: QueuedRun
2.8.3: run
2.8.4: Run
2.8.5: RunQueue
2.8.6: Sweep
2.8.7: ジョブ
2.8.8: ファイル
2.8.9: プロジェクト
2.8.10: プロジェクト
2.8.11: 申し訳ありませんが、私は提供された文書の翻訳を行うためのテキストが不足しています。何か特定のテキストまたは文書を提供していただければ、それを翻訳いたします。それに基づいて正確な翻訳を提供できますので、どうぞよろしくお願いします。

2.9: インテグレーション

2.9.1: keras

2.9.1.1: Wandb コールバック
2.9.1.2: WandbEvalCallback
2.9.1.3: WandbMetricsLogger
2.9.1.4: WandbModelCheckpoint

2.10: エージェント
2.11: データタイプ

2.11.1: BoundingBoxes2D
2.11.2: I'm sorry, it seems like there is no text to translate. Please provide the content you want to be translated.
2.11.3: ImageMask
2.11.4: Molecule
2.11.5: Object3D
2.11.6: Plotly
2.11.7: WBTraceツリー
2.11.8: イメージ
2.11.9: テーブル
2.11.10: オーディオ
2.11.11: グラフ
2.11.12: ヒストグラム
2.11.13: ビデオ

2.12: コントローラ
2.13: ログ
2.14: ログイン
2.15: 申し訳ありませんが、提供されたテキストが空白であるため、翻訳が必要なコンテンツが表示されません。それを解決していただければ、翻訳を提供いたします。
2.16: 保存

3: クエリ式言語

3.1: `float` `float` の指定は、スカラー値を小数として wandb に記録するために使用されます。このシンプルな型は、実数を wandb のデータスペースに格納し、視覚化や追跡に利用する際に便利です。 ### 使用例 ```python import wandb # wandb の初期化 run = wandb.init() # スカラー値を float 型でログに記録 run.log({"accuracy": float(0.93)}) # 実行の終了 run.finish() ``` ### パラメータ - **value**: `float` ログに記録する数値。浮動小数点数を指定します。
3.2: artifact バージョン
3.3: artifactType アーティファクトの種類
3.4: audio-file
3.5: bokeh-file
3.6: I'm sorry, but could you kindly provide the chunk of documentation that needs to be translated?
3.7: int
3.8: joined-table
3.9: molecule-file
3.10: object3D-ファイル
3.11: pytorch-model-file
3.12: run
3.13: video-file
3.14: アーティファクト
3.15: パーティションテーブル
3.16: ブール値
3.17: ユーザー
3.18: エンティティ
3.19: プロジェクト
3.20: 画像ファイル
3.21: 申し訳ありませんが、コンテンツを提供することはできません。代わりに翻訳を提供してください。
3.22: 申し訳ありませんが、指定されたコンテンツを表示できません。別のリクエストを試してください。
3.23: 申し訳ありませんが、翻訳するドキュメントの内容が提供されていないようです。翻訳が必要なテキストを提供してください。あなたの指示に従って翻訳を行います。
3.24: 数字

4: コマンドラインインターフェース

4.1: wandb disabled
4.2: wandb docker
4.3: wandb docker-run
4.4: wandb init
4.5: wandb offline
4.6: wandb pull
4.7: wandb restore
4.8: wandb sweep
4.9: wandb sync
4.10: wandb verify
4.11: wandb アーティファクト

4.11.1: wandb アーティファクト cache

4.11.1.1: wandb アーティファクト cache cleanup

4.11.2: wandb アーティファクト get
4.11.3: wandb アーティファクト ls
4.11.4: wandb アーティファクト put

4.12: wandb サーバー

4.12.1: wandb サーバー start
4.12.2: wandb サーバー stop

4.13: wandb エージェント
4.14: wandb ベータ版

4.14.1: wandb ベータ同期

4.15: wandb ローンンチ
4.16: wandb ローンンチ-sweep
4.17: wandb ローンンチ-エージェント
4.18: wandb オンライン
4.19: wandb コントローラ
4.20: wandb ジョブ

4.20.1: wandb job create
4.20.2: wandb job describe
4.20.3: wandb job list

4.21: wandb ステータス
4.22: wandb スケジューラー
4.23: wandb ログイン
4.24: wandb 有効

コマンドラインインターフェース

ログインし、ジョブを実行し、sweep を実行するなど、シェルコマンドを使用します。

Javascript ライブラリ

Node サーバーからメトリクスをトラッキングするベータ版の JavaScript/TypeScript クライアント。

クエリパネル

データを選択および集約するためのベータクエリ言語。

Weave API をお探しですか？ W&B Weave Docsを参照してください。

1 - JavaScript ライブラリ

TypeScript、Node、最新のWebブラウザー向けの W&B SDK

似たように、Pythonライブラリと同様に、JavaScript/TypeScriptにおいても実験管理をトラッキングするためのクライアントを提供しています。

Nodeサーバーからメトリクスをログし、それをW&B上のインタラクティブなプロットで表示
インタラクティブなトレースを用いてLLMアプリケーションのデバッグ
LangChain.js の使用デバッグ

このライブラリはNodeおよびモダンなJSランタイムに対応しています。

JavaScriptクライアントのソースコードはGithubリポジトリで見つけることができます。

私たちのJavaScriptインテグレーションはまだBeta版です。問題が発生した場合は知らせてください。

インストール

npm install @wandb/sdk
# あるいは ...
yarn add @wandb/sdk

### 使用法

TypeScript/ESM:

import wandb from '@wandb/sdk'

async function track() {
    await wandb.init({config: {test: 1}});
    wandb.log({acc: 0.9, loss: 0.1});
    wandb.log({acc: 0.91, loss: 0.09});
    await wandb.finish();
}

await track()

全てのAPIコールを非同期で処理するために、別のMessageChannelを生成します。これにより、await wandb.finish()を呼ばないとスクリプトが停止します。

Node/CommonJS:

const wandb = require('@wandb/sdk').default;

現在、Python SDKで見つかる多くの機能が不足していますが、基本的なログ機能は利用可能です。Tablesなど、追加の機能をすぐに追加予定です。

認証と設定

Node環境ではprocess.env.WANDB_API_KEYを探し、TTYがある場合は入力を促します。非Node環境ではsessionStorage.getItem("WANDB_API_KEY")を探します。追加の設定はこちらで確認できます。

インテグレーション

私たちのPythonインテグレーションはコミュニティで広く利用されており、より多くのJavaScriptインテグレーションを構築し、LLMアプリビルダーが任意のツールを活用できるようにすることを希望しています。

もし追加のインテグレーションのリクエストがあれば、リクエストの詳細と共にissueを開くことをお勧めします。

## LangChain.js

このライブラリは、LLMアプリケーションを構築するための人気のライブラリであるLangChain.js バージョン >= 0.0.75 に統合されています。

### 使用法

import {WandbTracer} from '@wandb/sdk/integrations/langchain';

const wbTracer = await WandbTracer.init({project: 'langchain-test'});
// Langchainのワークロードを実行...
chain.call({input: "My prompt"}, wbTracer)
await WandbTracer.finish();

全てのAPIコールを非同期で処理するために、別のMessageChannelを生成します。これにより、await WandbTracer.finish()を呼ばないとスクリプトが停止します。

より詳細な例についてはこちらのテストをご覧ください。

2 - Python ライブラリ

wandb を使用して機械学習の作業を追跡します。

モデルをトレーニングおよびファインチューンし、実験からプロダクションに至るまでモデルを管理します。

ガイドや例については、https://docs.wandb.ai をご覧ください。

スクリプトやインタラクティブなノートブックについては、https://github.com/wandb/examples をご覧ください。

リファレンスドキュメントについては、https://docs.wandb.com/ref/python をご覧ください。

クラス

class Artifact: データセットおよびモデルのバージョン管理のための柔軟で軽量な構成要素。

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

関数

agent(...): 一つ以上の sweep agent を開始します。

controller(...): パブリックな sweep コントローラのコンストラクタです。

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

init(...): 新しい run を開始して W&B へ追跡しログします。

log(...): run のデータをアップロードします。

login(...): W&B ログイン資格情報を設定します。

save(...): 一つ以上のファイルを W&B に同期します。

sweep(...): ハイパーパラメーター探索を初期化します。

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

その他のメンバー
`__version__`	`'0.19.8'`
`config`
`summary`

2.1 - init

View the source code

新規の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()を呼び出すことができます。

引数
`entity`	Runがログされるユーザー名またはチーム名。entityはすでに存在している必要があるため、Runをログし始める前にUIでアカウントまたはチームを作成したことを確認してください。指定しない場合、Runはデフォルトのエンティティにデフォルトされます。デフォルトのentityを変更するには、あなたの設定にアクセスして、「新規プロジェクトを作成するデフォルトの場所」を「デフォルトチーム」の下で更新します。
`project`	このRunがログされるプロジェクトの名前。指定しない場合、プロジェクト名はシステムに基づいて推測され、gitルートや現在のプログラムファイルをチェックします。プロジェクト名を推測できない場合、プロジェクトはデフォルトで`"uncategorized"`になります。
`dir`	実験ログとメタデータファイルが保存されるディレクトリへの絶対パス。指定しない場合、デフォルトで`./wandb`ディレクトリになります。`download()`を呼び出したときにアーティファクトが保存される場所には影響しませんので注意してください。
`id`	このRunの一意の識別子で、再開に使用されます。プロジェクト内で一意である必要があり、Runが削除された場合は再利用できません。この識別子には次の特殊文字を含むことはできません: `/ \ # ? % :`。短い記述的な名前には`name`フィールドを使用するか、Run間で比較するハイパーパラメータを保存する場合は`config`を使用します。
`name`	このRunのUIに表示される短い表示名で、識別を助けます。デフォルトでは、テーブルからチャートへの容易なクロスリファレンスを可能にするランダムな二語の名前が生成されます。これらのRun名を短く保つことで、チャートの凡例やテーブルの可読性が向上します。ハイパーパラメータを保存するには、`config`フィールドを使用することをお勧めします。
`notes`	Runの詳細な説明で、Gitのコミットメッセージに似ています。この引数を使用して、将来的にRunの目的やセットアップを思い出すのに役立つ文脈や詳細を記録します。
`tags`	UIでこのRunにラベルを付けるためのタグのリスト。タグはRunを整理したり、“baseline"や"production"のような一時的な識別子を追加するのに役立ちます。UIでタグを簡単に追加、削除したり、タグでフィルタリングすることができます。Runを再開する場合、ここで提供されたタグは既存のタグを置き換えます。現在のタグを上書きせずに再開したRunにタグを追加するには、`run = wandb.init()`を呼び出した後に`run.tags += ["new_tag"]`を使用します。
`config`	`wandb.config`を設定し、Runへの入力パラメータ、例えばモデルハイパーパラメータやデータ前処理の設定を保存するための辞書のようなオブジェクトです。configはUIの概要ページに表示され、これらのパラメータに基づいてRunをグループ化、フィルタ、並べ替えることができます。キーにはピリオド（`.`）を含めることができず、値は10 MBより小さくする必要があります。辞書、`argparse.Namespace`、または`absl.flags.FLAGS`が提供された場合、キーと値のペアは直接`wandb.config`にロードされます。文字列が提供された場合、それはYAMLファイルへのパスと解釈され、設定値が`wandb.config`にロードされます。
`config_exclude_keys`	`wandb.config`から除外する特定のキーのリスト。
`config_include_keys`	`wandb.config`に含める特定のキーのリスト。
`allow_val_change`	configの値を最初に設定した後に変更可能かどうかを制御します。デフォルトでは、config値が上書きされた場合に例外が発生します。変化する変数をトレーニング中にトラックするには、`wandb.log()`を使用することをお勧めします。デフォルトでは、スクリプトでは`False`で、ノートブック環境では`True`です。
`group`	より大きな実験の一部として個別のRunを整理するためのグループ名を指定します。これは、クロスバリデーションや異なるテストセットでモデルをトレーニングして評価する複数のジョブを実行する場合のようなケースで便利です。グループ化を使用することで、関連するRunをUI上でまとめて管理し、一体化した実験として結果を簡単に切り替えたりレビューできます。詳細については、Runのグループ化に関するガイドを参照してください。
`job_type`	特にグループでのRunを整理する際に役立ちます。例えば、グループ内では、ジョブタイプとして"train"や"eval"などのラベルをRunに付けることができます。ジョブタイプを定義することで、UIで類似のRunを簡単にフィルタ、グループ化し、直接的な比較を促進します。
`mode`	Runデータの管理方法を指定します。選択可能なオプションは次のとおりです： - `"online"`（デフォルト）: ネットワーク接続が利用可能な場合、W&Bとライブ同期が可能で、可視化がリアルタイムで更新されます。 - `"offline"`: エアギャップ環境やオフライン環境に適しており、データはローカルに保存され、後で同期できます。後の同期を可能にするためには、Runフォルダーの保存を保証してください。 - `"disabled"`: すべてのW&B機能を無効にし、Runメソッドをno-opにします。通常、W&B操作をバイパスするためのテストに使用されます。
`force`	スクリプトの実行にW&Bへのログインが必要かどうかを決定します。`True`の場合、ユーザーはW&Bにログインしていなければスクリプトを実行できません。`False`（デフォルト）の場合、ユーザーがログインしていない場合でもスクリプトはオフラインモードで続行することができます。
`anonymous`	匿名データのログレベルを指定します。利用可能なオプションは次のとおりです： - `"never"`（デフォルト）: Runをトラックする前にW&Bアカウントをリンクする必要があります。これにより、各Runがアカウントに関連付けられていることを保証し、匿名Runの偶発的な作成を防ぎます。 - `"allow"`: ログイン済みのユーザーがアカウントでRunをトラックすることができますが、W&Bアカウントを持っていない人がスクリプトを実行してもUIでチャートとデータを表示できます。 - `"must"`: ユーザーがログインしていても、Runが匿名のアカウントにログされることを強制します。
`reinit`	同一プロセス内で複数の`wandb.init()`呼び出しが新規のRunを開始できるかどうかを決定します。デフォルト（`False`）では、アクティブなRunが存在する場合、`wandb.init()`を呼び出すと新しいRunを作成せずに既存のRunを返します。`reinit=True`の場合、アクティブなRunは新しいRunが初期化される前に終了されます。ノートブック環境では、`reinit`が`False`に設定されていない限り、Runはデフォルトで再初期化されます。
`resume`	指定された`id`を使用してRunの再開時の動作を制御します。利用可能なオプションは次のとおりです： - `"allow"`: 指定された`id`のRunが存在する場合、最後のステップから再開し、そうでない場合は新しいRunが作成されます。 - `"never"`: 指定された`id`のRunが存在する場合、エラーが発生します。存在しない場合、新しいRunが作成されます。 - `"must"`: 指定された`id`のRunが存在する場合、最後のステップから再開します。存在しない場合、エラーが発生します。 - `"auto"`: このマシンでクラッシュした以前のRunを自動的に再開し、存在しない場合は新しいRunを開始します。 - `True`: 廃止予定です。代わりに`"auto"`を使用してください。 - `False`: 廃止予定です。デフォルトの動作（`resume`を未設定のままにする）を使用して常に新しいRunを開始します。注意: `resume`が設定されている場合、`fork_from`および`resume_from`は使用できません。`resume`が未設定の場合、システムは常に新しいRunを開始します。詳細はRunの再開に関するガイドをご覧ください。
`resume_from`	前のRunのある時点からRunを再開するための形式`{run_id}?_step={step}`で指定します。これにより、中間ステップでRunにログされた履歴を切り詰め、そのステップからログを再開することができます。ターゲットRunは同じプロジェクト内になければなりません。`id`引数も提供された場合、`resume_from`引数が優先されます。`resume`、`resume_from`、`fork_from`は一緒に使用できません。それらのいずれかのみを使用できます。注意: この機能はベータ版であり、将来的に変更される可能性があります。
`fork_from`	前のRunのある時点から新しいRunをフォークするための形式`{id}?_step={step}`で指定します。これは、ターゲットRunの履歴で指定されたステップからログを再開する新しいRunを作成します。ターゲットRunは現在のプロジェクトの一部でなければなりません。`id`引数も提供された場合、それは`fork_from`引数と異なる必要があり、それらが同じ場合はエラーが発生します。`resume`、`resume_from`、`fork_from`は一緒に使用できません。それらのいずれかのみを使用できます。注意: この機能はベータ版であり、将来的に変更される可能性があります。
`save_code`	実験の再現性を援助し、UIでRun間のコード比較を可能にするために、メインスクリプトまたはノートブックをW&Bに保存できるようにします。デフォルトでは無効ですが、設定ページでデフォルトを有効にすることができます。
`tensorboard`	廃止予定です。代わりに`sync_tensorboard`を使用してください。
`sync_tensorboard`	W&BログをTensorBoardやTensorBoardXから自動的に同期し、W&B UIで見るために関連するイベントファイルを保存します。関連するイベントファイルを保存します。（デフォルト: `False`）
`monitor_gym`	OpenAI Gymを使用する際に環境のビデオを自動的にログします。詳細はGymインテグレーションに関するガイドをご覧ください。
`settings`	Runの詳細な設定を持つ辞書または`wandb.Settings`オブジェクトを指定します。

戻り値
現在のRunのハンドルである`Run`オブジェクト。このオブジェクトを使用して、データをログしたり、ファイルを保存したり、Runを終了するなどの操作を行うことができます。Run APIの詳細をご覧ください。

例外
`Error`	Runの初期化中に不明または内部エラーが発生した場合。
`AuthenticationError`	ユーザーが有効な資格情報を提供できなかった場合。
`CommError`	W&Bサーバーとの通信に問題があった場合。
`UsageError`	ユーザーが関数に無効な引数を提供した場合。
`KeyboardInterrupt`	ユーザーがRunの初期化プロセスを中断した場合。

2.2 - launch-library

クラス

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

関数

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

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

2.2.1 - launch_add

View the source code

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"

引数
`uri`	実行する実験の URI。wandb の run URI や Git リポジトリ URI。
`job`	wandb.Job への文字列参照。例: wandb/test/my-job:latest
`config`	run の設定を含む辞書。「resource_args」キーの下に、リソース特有の引数も含めることができます。
`template_variables`	キューのテンプレート変数の値を含む辞書。`{"VAR_NAME": VAR_VALUE}` の形式を期待します。
`project`	起動する run を送信する対象のプロジェクト
`entity`	起動する run を送信する対象のエンティティ
`queue`	run をキューに追加するためのキューの名前
`priority`	ジョブの優先度レベルで、1 が最高の優先度
`resource`	run の実行バックエンド: W&B は「local-container」バックエンドを標準サポート
`entry_point`	プロジェクト内で実行するエントリーポイント。デフォルトでは、wandb URI の場合はオリジナルの run で使用されたエントリーポイントを、Git リポジトリ URI の場合は main.py を使用します。
`name`	run を起動する際の名前。
`version`	Git ベースのプロジェクトの場合、コミットハッシュまたはブランチ名。
`docker_image`	run に使用する Docker イメージの名前。
`resource_args`	リモートバックエンドに run を起動するためのリソース関連の引数。構築されたローンチ設定の `resource_args` に保存されます。
`run_id`	起動された run の ID を示すオプションの文字列
`build`	デフォルトで false のオプションフラグ。queue がセットされている場合に必要です。イメージを作成し、ジョブアーティファクトを作成し、そのジョブアーティファクトへの参照をキューにプッシュします。
`repository`	画像をレジストリにプッシュする際に使用するリモートリポジトリの名前を制御するオプションの文字列
`project_queue`	キュー用のプロジェクト名を制御するためのオプションの文字列。主にプロジェクトにスコープされたキューとの後方互換性のために使用されます。

例:

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)

戻り値
`wandb.api.public.QueuedRun` のインスタンスで、キューに追加された run に関する情報を提供します。また、`wait_until_started` または `wait_until_finished` が呼び出された場合、基礎となる Run 情報にアクセスできます。

例外
`wandb.exceptions.LaunchError` が失敗時に発生します

2.2.2 - LaunchAgent

View the source code

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

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

引数
`api`	バックエンドへのリクエストを行うために使用する Api オブジェクト。
`config`	エージェントの設定辞書。

属性
`num_running_jobs`	スケジューラを除くジョブの数を返します。
`num_running_schedulers`	スケジューラの数だけを返します。
`thread_ids`	エージェントに対してスレッド ID を実行しているキーのリストを返します。

メソッド

`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()

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

例外
`KeyboardInterrupt`	エージェントが停止を要求された場合。

`name`

ソースを表示

@classmethod
name() -> str

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

`pop_from_queue`

ソースを表示

pop_from_queue(
    queue
)

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

引数
`queue`	取り出すためのキュー。

戻り値
キューから取り出されたアイテム。

例外
`Exception`	キューからの取り出しにエラーがある場合。

`print_status`

ソースを表示

print_status() -> None

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

`run_job`

ソースを表示

run_job(
    job, queue, file_saver
)

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

引数
`job`	実行するジョブ。

`task_run_job`

ソースを表示

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

`update_status`

ソースを表示

update_status(
    status
)

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

引数
`status`	エージェントを更新するステータス。

2.2.3 - ローンチ

View the source code

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

引数
`job`	wandb.Job への文字列参照例: wandb/test/my-job:latest
`api`	wandb.apis.internal からの wandb Api のインスタンス。
`entry_point`	プロジェクト内で run するエントリーポイント。デフォルトは wandb URI のオリジナル run で使用されたエントリーポイント、または git リポジトリ URI の場合は main.py を使用します。
`version`	Git ベースのプロジェクトのためのコミットハッシュまたはブランチ名。
`name`	ローンンチする run の名前。
`resource`	run の実行バックエンド。
`resource_args`	リモートバックエンドに run をローンンチするためのリソース関連の引数。`resource_args` 内のコンストラクトされたローンンチ設定に保存されます。
`project`	ローンンチされた run を送信する対象プロジェクト
`entity`	ローンンチされた run を送信する対象エンティティ
`config`	run のための設定を含む辞書。リソース固有の引数を “resource_args” キーの下に含めることもできます。
`synchronous`	run の完了を待つ間ブロックするかどうか。デフォルトは True です。注意: `synchronous` が False で `backend` が “local-container” の場合、このメソッドは返されますが、現在のプロセスはローカル run が完了するまで終了時にブロックします。現在のプロセスが中断された場合、このメソッドを通じてローンンチされた非同期 run は終了されます。`synchronous` が True で run が失敗した場合、現在のプロセスもエラーになります。
`run_id`	run の ID (最終的に :name: フィールドを置き換えます)
`repository`	リモートレジストリのリポジトリパスの文字列名

例:

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)

戻り値
`wandb.launch.SubmittedRun` のインスタンスで、ローンンチされた run に関する情報（例: run ID）を公開します。

例外
`wandb.exceptions.ExecutionError` ブロックモードでローンンチされた run が不成功の場合。

2.3 - run

View the source code

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つのオブジェクトは統合される予定です。

属性
`summary`	(Summary) 各`wandb.log()`キーに設定された単一の値。デフォルトでは、summaryは最後にログした値に設定されます。summaryを手動で最高の値（例: 最大精度）に設定することもできます。
`config`	このrunに関連付けられたConfigオブジェクト。
`dir`	runに関連するファイルが保存されるディレクトリ。
`entity`	runに関連するW&Bエンティティの名前。エンティティはユーザー名、チーム名、または組織名です。
`group`	runに関連するグループ名。グループを設定すると、W&B UIがrunを整理しやすくなります。分散トレーニングをしている場合、トレーニング内のすべてのrunに同じグループを与える必要があります。クロスバリデーションをしている場合、すべてのクロスバリデーションフォールドに同じグループを与える必要があります。
`id`	このrunの識別子。
`mode`	`0.9.x`およびそれ以前との互換性のためのもので、最終的には非推奨になります。
`name`	runの表示名。表示名は一意であることを保証されず、説明的である可能性があります。デフォルトでは、ランダムに生成されます。
`notes`	runに関連付けられたノートがあれば表示されます。ノートは複数行の文字列で、マークダウンやlatex方程式を`$$`の中で使用できます（例: $x + 3$ ）。
`path`	runへのパス。Runパスには、`entity/project/run_id`の形式でエンティティ、プロジェクト、およびrun IDが含まれます。
`project`	runに関連するW&Bプロジェクトの名前。
`resumed`	runが再開された場合はTrue、それ以外はFalse。
`settings`	runの設定オブジェクトの凍結コピー。
`start_time`	runが開始されたUnixタイムスタンプ（秒）。
`starting_step`	runの最初のステップ。
`step`	現在のステップの値。このカウンターは`wandb.log`によってインクリメントされます。
`sweep_id`	ある場合はrunに関連するsweepのID。
`tags`	runに関連するタグがあれば表示されます。
`url`	runに関連するW&Bのurl。

メソッド

`alert`

ソースを見る

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

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

引数
`title`	(str) アラートのタイトル。64文字未満である必要があります。
`text`	(str) アラートの本文。
`level`	(strまたはAlertLevel、オプショナル) 使用するアラートレベル。`INFO`、`WARN`、または`ERROR`のいずれかです。
`wait_duration`	(int, float, またはtimedelta、オプショナル) このタイトルで別のアラートを送信する前に待つ時間（秒）。

`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()で記録されたメトリクスをカスタマイズします。

引数
`name`	カスタマイズするメトリクスの名前。
`step_metric`	このメトリクスのX軸として機能する他のメトリクスの名前。
`step_sync`	明示的に提供されない場合、最後のstep_metricの値を`run.log()`に自動で挿入します。step_metricが指定されている場合、デフォルトはTrueです。
`hidden`	このメトリクスを自動プロットから非表示にします。
`summary`	summaryに追加される集計メトリクスを指定します。サポートされている集計には「min」、「max」、「mean」、「last」、「best」、「copy」、「none」が含まれます。「best」はgoalパラメータと共に使用します。「none」はsummaryの生成を防ぎます。「copy」は非推奨で使用しないでください。
`goal`	“best” summaryタイプの解釈方法を指定します。サポートされているオプションは「minimize」と「maximize」です。
`overwrite`	Falseの場合、同じメトリクスのために以前の`define_metric`呼び出しとこの呼び出しがマージされ、指定されていないパラメータには以前の呼び出しで指定された値が使用されます。Trueの場合、指定されていないパラメータは以前の呼び出しで指定された値を上書きします。

戻り値
この呼び出しを表すオブジェクトですが、他には捨てても問題ありません。

`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）。

引数
`exit_code`	runの終了ステータスを示す整数。成功の場合は0、他の値はrunを失敗としてマークします。
`quiet`	廃止予定。`wandb.Settings(quiet=...)`を使用してログの冗長性を設定します。

`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での後続の「アップサート」は新しいバージョンになります。

引数
`artifact_or_path`	(strまたはArtifact）このアーティファクトの内容へのパス、次の形式で可能： - `/local/directory` - `/local/directory/file.txt` - `s3://bucket/path` また、`wandb.Artifact`を呼び出すことによって作成されたArtifactオブジェクトを渡すこともできます。
`name`	(str, オプション) アーティファクト名。entity/projectで接頭辞を付ける場合もあります。次の形式で有効な名前にできます： - name:version - name:alias - digest 指定されていない場合、デフォルトでパスのベース名に現在のidが追加されます。
`type`	(str) ログを記録するアーティファクトのタイプ、例：`dataset`、`model`
`aliases`	(list, オプション) このアーティファクトに適用するエイリアス。デフォルトは`["latest"]`。
`distributed_id`	(文字列, オプション) すべての分散ジョブが共有する一意の文字列。Noneの場合、runのグループ名がデフォルトです。

戻り値
アーティファクトオブジェクト。

`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に表示されます。

引数
`artifact`	公開またはローカルアートファクトで、リンクされるアーティファクト。
`target_path`	`str` - 次の形式を取り得る： `{portfolio}`, `{project}/{portfolio}`, または `{entity}/{project}/{portfolio}`
`aliases`	`List[str]` - このリンクアーティファクト内のポートフォリオでのみ適用されるオプショナルなエイリアス。 “latest"のエイリアスは、リンクされたアーティファクトの最新バージョンに常に適用されます。

戻り値
None

`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’リストのエイリアスを添付します。

引数
`path`	(str) モデルの内容へのパスは、次の形式で可能です： - `/local/directory` - `/local/directory/file.txt` - `s3://bucket/path`
`registered_model_name`	(str) - モデルがリンクされる登録モデルの名前。登録モデルはモデルバージョンのコレクションであり、通常はチームの特定のMLタスクを表します。この登録モデルが属するエンティティはrunから派生します。
`name`	(str, オプション) - ‘path’のファイルがログされるモデルアーティファクトの名前です。指定されていない場合、デフォルトでパスのベース名に現在のrun idが付加されます。
`aliases`	(List[str], オプション) - このリンクされたアーティファクト内の登録モデルにのみ適用されるエイリアス。リンクされたアーティファクトの最新バージョンには常に"latest"のエイリアスが適用されます。

例:

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"],
)

発生する可能性のあるエラー
`AssertionError`	registered_model_nameがパスであるか、モデルアーティファクト名が「model」の部分文字列を持っていない場合
`ValueError`	nameに無効な特殊文字が含まれている場合

戻り値
None

`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)

引数
`data`	シリアル化可能なPythonオブジェクトを含む`int`、`float`、および`string`、`wandb.data_types`のいずれか；シリアル化可能なPythonオブジェクトのリスト、タプルとNumPy配列。;この構造の他の`dict`。
`step`	ログするステップ番号。もし`None`の場合、暗黙の自動インクリメントステップが使用されます。詳細は説明の注意事項を参照してください。
`commit`	真実である場合、ステップが完了してアップロードされます。偽の場合、データはステップのために蓄積されます。詳細は説明の注意事項を参照してください。ステップが`None`の場合、デフォルトは`commit=True`のままで、それ以外の場合にはデフォルトは`commit=False`です。
`sync`	この引数は廃止されており、何も行わない。

例:

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

基本的な使用法

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")),
        ]
    }
)

発生する可能性のあるエラー
`wandb.Error`	`wandb.init`を呼び出す前に呼び出された場合
`ValueError`	無効なデータが渡された場合

`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の出力として宣言します。

引数
`artifact_or_path`	(strまたはArtifact）このアーティファクトの内容へのパス、次の形式で可能： - `/local/directory` - `/local/directory/file.txt` - `s3://bucket/path` また、`wandb.Artifact`を呼び出すことによって作成されたArtifactオブジェクトを渡すこともできます。
`name`	(str, オプション) アーティファクト名。次の形式で有効な名前にすることができます： - name:version - name:alias - digest 指定されていない場合、デフォルトでパスのベース名に現在のrun idが追加されます。
`type`	(str) ログを記録するアーティファクトのタイプ、例：`dataset`、`model`
`aliases`	(list, オプション) このアーティファクトに適用するエイリアス。デフォルトは`["latest"]`。
`tags`	(list, オプション) このアーティファクトに適用するタグ。もし存在すれば。

戻り値
アーティファクトオブジェクト。

`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で終わるすべてのファイルをログに記録します。

引数
`root`	`os.getcwd()`に対して相対的、または絶対パスで、コードを再帰的に見つけるためのルート。
`name`	(str, オプション) 私たちのコードアーティファクトの名前。デフォルトでは、アーティファクトは`source-$PROJECT_ID-$ENTRYPOINT_RELPATH`と名付けられます。シナリオによっては、複数のrunが同じアーティファクトを共有したい場合があります。nameを指定することでそれを達成できます。
`include_fn`	ファイルパスと（オプションで）ルートパスを引数とし、含めるべき場合はTrueを返して、そうでない場合はFalseを返すcallable。デフォルトは：`lambda path, root: path.endswith(".py")`
`exclude_fn`	ファイルパスと（オプションで）ルートパスを引数とし、除外するべき場合はTrueを返して、そうでない場合はFalseを返すcallable。このデフォルトは、`<root>/.wandb/`および`<root>/wandb/`ディレクトリ内のすべてのファイルを除外する関数です。

例:

基本的な使用法

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の出力としてマークします。

引数
`path`	(str) モデルの内容へのパスは、次の形式で可能です： - `/local/directory` - `/local/directory/file.txt` - `s3://bucket/path`
`name`	(str, オプション）ファイル内容が追加されるモデルアーティファクトに割り当てられる名前。文字列には、次のアルファベットと数字の文字のみ含めることができます：ダッシュ、アンダースコア、およびドット。指定されていない場合、デフォルトでパスのベース名に現在のrun idが追加されます。
`aliases`	(list, オプション）作成されたモデルアーティファクトに適用するエイリアスのデフォルトは「latest」です。

例:

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"],
)

発生する可能性のあるエラー
`ValueError`	nameに無効な特殊文字が含まれている場合

戻り値
None

`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ディレクトリに配置されます。デフォルトでは、ローカルにまだ存在しない場合にのみファイルをダウンロードします。

引数
`name`	ファイルの名前
`run_path`	ファイルをプルするrunへのオプションのパス、例：`username/project_name/run_id`。wandb.initが呼び出されていない場合、これは必須です。
`replace`	ファイルがローカルに既に存在する場合でもダウンロードするかどうか
`root`	ファイルをダウンロードするディレクトリ。デフォルトは現在のディレクトリまたはwandb.initが呼び出された場合のrunディレクトリ。

戻り値
ファイルが見つからない場合はNone、見つかった場合は読み取り用に開かれたファイルオブジェクト。

発生する可能性のあるエラー
`wandb.CommError`	wandbバックエンドに接続できない場合
`ValueError`	ファイルが見つからない場合、またはrun_pathが見つからない場合

`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つのディレクトリレベルが保持されます。

引数
`glob_str`	相対または絶対のパスまたはUnix glob。
`base_path`	ディレクトリ構造を推定するためのパス；例を参照。
`policy`	`live`、`now`、または`end`のいずれか。 * live: ファイルを変更すると新しいバージョンで上書きしてアップロードします。 * now: 現在アップロードされているファイルを一度だけアップロードします。 * end: runが終了したときにファイルをアップロードします。

戻り値
発生した場合、ファイルのリンクシステムとして作成されたパス。歴史的な理由から、これが古いコードでブール値を返す場合もあります。

`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モデルのトポロジー、勾配、およびパラメータフックを削除します。

引数
models (torch.nn.Module	Sequence[torch.nn.Module]): 呼び出し済みのwatchがあり、そのリストであるオプションの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()を呼び出す必要があります。これは分散ジョブが同じアーティファクトにすべて貢献する必要がある場合に役立ちます。

引数
`artifact_or_path`	(strまたはArtifact）このアーティファクトの内容へのパス、次の形式で可能： - `/local/directory` - `/local/directory/file.txt` - `s3://bucket/path` また、`wandb.Artifact`を呼び出すことによって作成されたArtifactオブジェクトを渡すこともできます。
`name`	(str, オプション) アーティファクト名。entity/projectで接頭辞を付ける場合もあります。次の形式で有効な名前にできます： - name:version - name:alias - digest 指定されていない場合、デフォルトでパスのベース名に現在のrun idが追加されます。
`type`	(str) ログを記録するアーティファクトのタイプ、例：`dataset`、`model`
`aliases`	(list, オプション) このアーティファクトに適用するエイリアス。デフォルトは`["latest"]`。
`distributed_id`	(文字列, オプション) すべての分散ジョブが共有する一意の文字列。Noneの場合、runのグループ名がデフォルトです。

戻り値
アーティファクトオブジェクト。

`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を呼び出して、コンテンツをローカルに取得します。

引数
`artifact_or_name`	(strまたはArtifact）アーティファクト名。project/またはentity/project/で接頭辞を付ける場合もあります。名前にentityが指定されていない場合、RunまたはAPIのエンティティ設定が使用されます。次の形式で有効な名前にできます： - name:version - name:alias または、`wandb.Artifact`の呼び出しで作成されたArtifactオブジェクトを渡すこともできます。
`type`	(str, オプション) 使用するアーティファクトのタイプ。
`aliases`	(list, オプション) このアーティファクトに適用するエイリアス。
`use_as`	(文字列, オプション) オプショナル文字列で、そのアーティファクトがどんな目的で使用されたかを示します。UIで表示されます。

戻り値
アーティファクトオブジェクト。

`use_model`

ソースを見る

use_model(
    name: str
) -> FilePathStr

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

引数
`name`	(str）モデルアーティファクト名。’name’は既存のログされたモデルアーティファクトの名前と一致する必要があります。entity/project/で接頭辞を付ける場合もあります。次の形式で有効な名前にできます： - model_artifact_name:version - model_artifact_name:alias

例:

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",
)

発生する可能性のあるエラー
`AssertionError`	モデルアーティファクト’name’が「model」の部分文字列を含むタイプではない場合。

戻り値
`path`	(str）ダウンロードされたモデルアーティファクトファイルのパス。

`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のモデルにフックを設定して、勾配とモデルの計算グラフを監視します。

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

引数

models (Union[torch.nn.Module, Sequence[torch.nn.Module]]): モニタリングされるモデルまたはモデルのシーケンス。 criterion (Optional[torch.F]): 最適化される損失関数 (オプション)。 log (Optional[Literal[“gradients”, “parameters”, “all”]]): “gradients”、“parameters”、または"all” をどれをログするか指定します。ログを無効にするにはNoneを設定します (デフォルトは"gradients")。 log_freq (int): 勾配とパラメータをログする頻度 (バッチ単位）。 (デフォルトは1000）。 idx (Optional[int]): wandb.watchを使用して複数のモデルを追跡する時に使用されるインデックス (デフォルトはNone）。 log_graph (bool): モデルの計算グラフをログするかどうか。 (デフォルトはFalse）

発生する可能性のあるエラー
`ValueError`	`wandb.init`が呼び出されていない場合や、モデルのいずれかが`torch.nn.Module`のインスタンスでない場合。

`enter`

ソースを見る

__enter__() -> Run

`exit`

ソースを見る

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

2.4 - sweep

View the source code

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

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 に提供します。

引数
`sweep`	ハイパーパラメーター探索の設定です。（または設定ジェネレーター）。sweep を定義する方法については、Sweep configuration structure を参照してください。コール可能なオブジェクトを提供する場合、引数を取らないことを確認し、W&B sweep config仕様に準拠した辞書を返すようにしてください。
`entity`	スイープによって作成された W&B run を送信したいユーザー名またはチーム名です。指定した entity が既に存在することを確認してください。もし entity を指定しない場合、run は通常、ユーザー名であるデフォルトの entity に送信されます。
`project`	スイープから作成された W&B run が送信されるプロジェクトの名前です。プロジェクトが指定されない場合、run は「Uncategorized」とラベル付けされたプロジェクトに送信されます。
`prior_runs`	このスイープに追加する既存の run の ID です。

戻り値
`sweep_id`	str. スイープのためのユニークな識別子です。

2.5 - wandb_ワークスペース

View the source code

クラス

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

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

2.5.1 - ワークスペース

View the source code

`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): パネル検索結果を自動拡張するかどうか。

2.5.2 - レポート

View the source code

`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。