launch_add

소스 코드 보기

W&B Launch Experiment 를 대기열에 추가합니다. 소스 URI, Job 또는 docker_image 중 하나를 사용합니다.

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"

Arguments	설명
uri	실행할 Experiment 의 URI 입니다. W&B Run URI 또는 Git 리포지토리 URI 가 가능합니다.
job	wandb.Job 에 대한 문자열 참조입니다. 예: wandb/test/my-job:latest
config	Run 에 대한 설정(configuration)을 포함하는 사전(dictionary)입니다. “resource_args” 키 아래에 리소스 관련 인수를 포함할 수도 있습니다.
template_variables	Run 대기열을 위한 템플릿 변수 값들을 포함하는 사전입니다. {"VAR_NAME": VAR_VALUE} 형식이 권장됩니다.
project	Launch 된 Run 을 보낼 대상 Projects 입니다.
entity	Launch 된 Run 을 보낼 대상 Entities 입니다.
queue	Run 을 추가할 대기열의 이름입니다.
priority	Job 의 우선순위 레벨이며, 1이 가장 높은 우선순위입니다.
resource	Run 을 위한 실행 백엔드입니다. W&B 는 “local-container” 백엔드에 대한 내장 지원을 제공합니다.
entry_point	프로젝트 내에서 실행할 엔트리 포인트입니다. 기본값은 W&B URI 의 경우 원본 Run 에서 사용된 엔트리 포인트를 사용하고, Git 리포지토리 URI 의 경우 main.py 를 사용합니다.
name	Run 을 Launch 할 때 사용할 이름입니다.
version	Git 기반 프로젝트의 경우, 커밋 해시 또는 브랜치 이름입니다.
docker_image	Run 에 사용할 도커 이미지의 이름입니다.
resource_args	원격 백엔드에서 Run 을 Launch 하기 위한 리소스 관련 인수입니다. 생성된 Launch 설정의 resource_args 아래에 저장됩니다.
run_id	Launch 된 Run 의 ID 를 나타내는 선택적 문자열입니다.
build	기본값이 false 인 선택적 플래그입니다. build 가 설정된 경우 queue 가 지정되어야 하며, 이미지가 생성되고, Job Artifact 가 생성되어 해당 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 프로젝트를 실행하고 로컬 호스트에 
# 재현 가능한 도커 환경을 생성합니다.
api = wandb.apis.internal.Api()
launch_add(uri=project_uri, parameters=params)

Returns	설명
대기열에 추가된 Run 에 대한 정보를 제공하는 wandb.api.public.QueuedRun 인스턴스입니다. 만약 wait_until_started 또는 wait_until_finished 가 호출되면, 기본 Run 정보에 대한 엑세스를 제공합니다.

Raises	설명
실패 시 wandb.exceptions.LaunchError 가 발생합니다.