ソースコードを表示
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 | run キューのテンプレート変数の値を含む辞書。想定される形式は {"VAR_NAME": VAR_VALUE} |
project | 起動した run の送信先となる対象プロジェクト |
entity | 起動した run の送信先となる対象 entity |
queue | run を追加するキューの名前 |
priority | ジョブの優先度レベル。1 が最優先です |
resource | run の実行バックエンド。W&B は “local-container” バックエンドを組み込みでサポートしています |
entry_point | プロジェクト内で実行するエントリポイント。デフォルトでは、wandb URI には元の run で使用されたエントリポイント、Git リポジトリ URI には main.py を使用します。 |
name | run の起動時に使用する run 名。 |
version | Git ベースのプロジェクトでは、コミットハッシュまたはブランチ名を指定します。 |
docker_image | run に使用する Docker image の名前。 |
resource_args | run をリモートバックエンドで起動するためのリソース関連引数。作成された Launch 設定の resource_args に保存されます。 |
run_id | 起動した run の id を示す省略可能な文字列 |
build | デフォルトが false の省略可能なフラグ。build する場合は queue の設定が必要です。イメージが作成され、ジョブ artifact が作成され、そのジョブ artifact への参照が 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 |