メインコンテンツへスキップ

ソースコードを表示

W&B 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
引数説明
jobwandb.Job への文字列参照 (例: wandb/test/my-job:latest)
apiwandb.apis.internal の wandb Api インスタンス。
entry_pointプロジェクト内で実行するエントリポイント。デフォルトでは、wandb URI には元の run で使用されたエントリポイントが、git リポジトリ URI には main.py が使用されます。
versionGit ベースのプロジェクトでは、コミットハッシュまたはブランチ名を指定します。
namerun の起動時に使用する run 名。
resourcerun の実行バックエンド。
resource_argsリモートバックエンドで Runs を起動するためのリソース関連の引数。生成された Launch 設定の resource_args に保存されます。
project起動した run の送信先となる対象プロジェクト。
entity起動した run の送信先となる対象 entity。
configrun の設定を含む辞書。キー “resource_args” の下に、リソース固有の引数を含めることもできます。
synchronousrun の完了を待つ間、処理をブロックするかどうか。デフォルトは True です。synchronous が False で backend が “local-container” の場合、この method は復帰しますが、ローカル run が完了するまで現在のプロセスは終了時にブロックされます。現在のプロセスが中断された場合、この method を介して起動された非同期 run はすべて終了します。synchronous が True で run が失敗した場合、現在のプロセスもエラーになります。
run_idrun の 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)
戻り値説明
起動されたrunに関する情報 (例: run ID) を含むwandb.launch.SubmittedRunのインスタンス。
発生する例外説明
ブロッキングモードで起動されたrunが正常に完了しなかった場合、wandb.exceptions.ExecutionError