クラス
class LaunchAgent: 指定されたrunキューをポーリングし、wandb Launch のためにrunを起動するLaunch エージェントクラス。
関数
launch(...): W&B ローンンチ 実験を開始します。
launch_add(...): W&B ローンンチ 実験をキューに追加します。source uri、jobまたはdocker_imageのいずれかを使用します。
これは、このセクションの複数ページの印刷可能なビューです。 印刷するには、ここをクリックしてください.
launch-library
- 1: launch_add
- 2: LaunchAgent
- 3: ローンチ
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"
| 引数 | |
|---|---|
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 - LaunchAgent
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 |
エージェントを更新するステータス。 |
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
| 引数 | |
|---|---|
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 が不成功の場合。 |