launch_add

소스 코드 보기

source 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에 대한 문자열 레퍼런스입니다. 예: 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에 사용할 도커 이미지 이름입니다.
resource_args	원격 백엔드에서 run을 시작하기 위한 리소스 관련 매개변수입니다. 생성된 Launch 설정의 resource_args 아래에 저장됩니다.
run_id	시작된 run의 ID를 나타내는 선택 문자열입니다
build	기본값이 false인 선택 플래그입니다. build를 사용하려면 queue가 설정되어 있어야 하며, 이미지가 생성되고, job artifact가 생성되며, 해당 job artifact의 레퍼런스가 큐에 푸시됩니다
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)

반환값	설명
대기열에 있는 run 정보를 제공하는 wandb.api.public.QueuedRun 인스턴스이며, wait_until_started 또는 wait_until_finished를 호출한 경우 기본 Run 정보에도 접근할 수 있습니다.

예외	설명
실패한 경우 wandb.exceptions.LaunchError