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

このページの通常のビューに戻る.

launch-library

クラス

class LaunchAgent: run キューから run をポーリングし、wandb Launch の run を起動する Launch エージェントクラス。

関数

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

launch_add(...): W&B Launch の実験をエンキューします。ソース URI、ジョブ、または docker_image のいずれかを使用します。

1 - launch

View the source code

W&B の Launch の experiment を Launch します。

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 プロジェクト内で実行するエントリポイント。wandb URI の場合は元の run で使用されたエントリポイント、git リポジトリ URI の場合は main.py をデフォルトで使用します。
version Git ベースのプロジェクトの場合、コミットハッシュまたはブランチ名のいずれか。
name run を Launch する run 名。
resource run の実行バックエンド。
resource_args リモートバックエンドに run を Launch するためのリソース関連の引数。resource_args の下の構築された Launch 設定に保存されます。
project Launch された run の送信先となる対象の Project
entity Launch された run の送信先となる対象の Entity
config run の設定を含む辞書。キー “resource_args” の下にあるリソース固有の引数も含む場合があります。
synchronous run の完了を待機中にブロックするかどうか。デフォルトは True です。synchronous が False で、backend が “local-container” の場合、このメソッドは戻りますが、現在のプロセスはローカル run が完了するまで終了時にブロックされます。現在のプロセスが中断された場合、このメソッドを介して Launch された非同期 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)
戻り値
Launch された run に関する情報 (run ID など) を公開する wandb.launch.SubmittedRun のインスタンス。
例外
wandb.exceptions.ExecutionError ブロックモードで Launch された run が失敗した場合。

2 - launch_add

View the source code

W&B の Launch の experiment をエンキューします。ソース URI 、job 、または 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 実行する experiment の URI 。Wandb の run の URI または Git リポジトリの URI 。
job wandb.Job への文字列参照（例：wandb/test/my-job:latest）
config run の 設定 を含む 辞書 。キー “resource_args” の下にあるリソース固有の 引数 も含めることができます。
template_variables run queue の テンプレート 変数の 値 を含む 辞書 。{"VAR_NAME": VAR_VALUE} の 形式 が想定されます。
project Launch された run の送信先となるターゲット プロジェクト
entity Launch された run の送信先となるターゲット エンティティ
queue run をエンキューする queue の 名前
priority job の 優先度 。1 が 最も高い 優先度 です。
resource run の 実行 バックエンド：W&B は “local-container” バックエンドの組み込みサポートを提供します。
entry_point プロジェクト 内で 実行 する エントリーポイント。wandb URI の 場合は 元の run で 使用 された エントリーポイント、Git リポジトリ URI の 場合は main.py を デフォルト で 使用 します。
name run を Launch する際に 使用 する run の 名前 。
version Git ベース の プロジェクト の 場合、コミット ハッシュ または ブランチ 名 のいずれか。
docker_image run に 使用 する docker イメージ の 名前 。
resource_args リモート バックエンド への run の Launch に 関連 する リソース 引数 。resource_args の下で 構築 された Launch 設定 に 保存 されます。
run_id Launch された run の ID を 示す オプション の 文字列
build オプション の フラグ で、デフォルト は False です。queue を 設定 する 必要 が ある 場合、イメージ が 作成 され、job アーティファクト が 作成 され、その job アーティファクト への 参照 が queue に プッシュ されます。
repository イメージ を レジストリ に プッシュ する 際 に 使用 される、リモート リポジトリ の 名前 を 制御 する オプション の 文字列。
project_queue queue の プロジェクト の 名前 を 制御 する オプション の 文字列。主に プロジェクト スコープ の queue との 後方 互換性 のために 使用 されます。

例：

from wandb.sdk.launch import launch_add

project_uri = "https://github.com/wandb/examples"
params = {"alpha": 0.5, "l1_ratio": 0.01}
# Run 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

3 - LaunchAgent

View the source code

run が与えられた run キューをポーリングし、wandb の Launch 用に run を起動する Launch agent クラス。

LaunchAgent(
    api: Api,
    config: Dict[str, Any]
)
引数
api バックエンドへのリクエストを行うために使用する Api オブジェクト。
config agent の設定辞書。
属性
num_running_jobs スケジューラを含まないジョブの数を返します。
num_running_schedulers スケジューラの数だけを返します。
thread_ids agent のスレッド 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

agent が初期化されているかどうかを返します。

loop

ソースを表示

loop()

ジョブを無限にポーリングして実行します。

例外
KeyboardInterrupt agent が停止を要求された場合。

name

ソースを表示

@classmethod
name() -> str

agent の名前を返します。

pop_from_queue

ソースを表示

pop_from_queue(
    queue
)

ジョブとして実行するために、runqueue からアイテムをポップします。

引数
queue ポップするキュー。
戻り値
キューからポップされたアイテム。
例外
Exception キューからのポップ中にエラーが発生した場合。

ソースを表示

print_status() -> None

agent の現在のステータスを出力します。

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
)

agent のステータスを更新します。

引数
status agent を更新するステータス。