> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wandb.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Launch API

<Card title="소스 코드 보기" href="https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/launch/_launch.py#L249-L331" icon="github" />

W\&B Launch 실험을 실행합니다.

```python theme={null}
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
```

| 매개변수            | 설명                                                                                                                                                                                                                                                          |
| :-------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `job`           | wandb.Job을 가리키는 문자열 레퍼런스입니다. 예: wandb/test/my-job:latest                                                                                                                                                                                                    |
| `api`           | wandb.apis.internal의 wandb Api 인스턴스입니다.                                                                                                                                                                                                                     |
| `entry_point`   | 프로젝트 내에서 실행할 진입점입니다. 기본적으로 wandb URI에는 원래 run에서 사용된 진입점을 사용하고, Git 저장소 URI에는 main.py를 사용합니다.                                                                                                                                                                |
| `version`       | Git 기반 프로젝트의 경우 커밋 해시 또는 브랜치 이름입니다.                                                                                                                                                                                                                         |
| `name`          | run을 Launch할 때 사용할 run 이름입니다.                                                                                                                                                                                                                               |
| `resource`      | run의 실행 백엔드입니다.                                                                                                                                                                                                                                             |
| `resource_args` | 원격 백엔드에서 run을 Launch하기 위한 리소스 관련 매개변수입니다. 생성된 Launch 설정의 `resource_args`에 저장됩니다.                                                                                                                                                                            |
| `project`       | Launch된 run을 보낼 대상 프로젝트입니다.                                                                                                                                                                                                                                 |
| `entity`        | Launch된 run을 보낼 대상 entity입니다.                                                                                                                                                                                                                               |
| `config`        | run의 설정을 담은 사전입니다. 키 "resource\_args" 아래에 리소스별 매개변수가 포함될 수도 있습니다.                                                                                                                                                                                           |
| `synchronous`   | run이 완료될 때까지 대기하며 차단할지 여부입니다. 기본값은 True입니다. `synchronous`가 False이고 `backend`가 "local-container"이면 이 메서드는 반환되지만, 현재 프로세스는 종료 시 로컬 run이 완료될 때까지 차단됩니다. 현재 프로세스가 중단되면 이 메서드로 Launch한 모든 비동기 run이 종료됩니다. `synchronous`가 True인데 run이 실패하면 현재 프로세스도 함께 오류로 종료됩니다. |
| `run_id`        | run의 ID입니다(:name: 필드를 최종적으로 대체할 예정)                                                                                                                                                                                                                         |
| `repository`    | 원격 레지스트리용 저장소 경로의 문자열 이름입니다.                                                                                                                                                                                                                                |

<div id="example">
  #### 예시:
</div>

```python theme={null}
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` 인스턴스입니다. |    |

| 예외                                                           | 설명 |
| :----------------------------------------------------------- | :- |
| `wandb.exceptions.ExecutionError` 차단 모드로 실행된 run이 실패한 경우입니다. |    |