launch_add - CoreWeave Docs

ソースコードを表示

ソース URI、ジョブ、または docker_image を指定して、W&B Launch の実験をキューに追加します。

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

例:

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)

戻り値	説明
キューに登録された run に関する情報を提供する`wandb.api.public.QueuedRun`のインスタンス。`wait_until_started` または `wait_until_finished` を呼び出した場合は、基になる run の情報にアクセスできます。

送出される例外	説明
失敗した場合は `wandb.exceptions.LaunchError`

ソースコードを表示

​例:

例: