launch_add

ソースコードを表示

W&B Launch 実験をキューに追加します。ソース URI、Job、または Docker イメージのいずれかを使用します。

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

​

例:

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	失敗した場合に発生します。