> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coreweave.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Run
export const GitHubLink = ({url, compact = false}) =>
{compact ? "View source" : <>
GitHub source
}
;
wandb-core 서비스에 대한 인터페이스로, 이 run에 대한 W\&B 호출을 수행합니다.
run에 연결된 entity입니다.
run에 연결된 프로젝트입니다.
run의 고유 식별자입니다.
run의 속성입니다.
run에 스윕을 포함할지 여부입니다.
설명이 제공되지 않았습니다.
설명이 제공되지 않았습니다.
속성
* `tags` (`[str]`): run과 연결된 태그 목록
* `url` (`str`): 이 run의 URL
* `id` (`str`): run의 고유 식별자 (기본값은 8자)
* `name` (`str`): run의 이름
* `state` (`str`): running, finished, crashed, killed, preempting, preempted 중 하나
* `config` (`dict`): run과 연결된 하이퍼파라미터의 설정
* `created_at` (`str`): run이 시작된 ISO 타임스탬프
* `system_metrics` (`dict`): run에 대해 기록된 최신 시스템 메트릭
* `summary` (`dict`): 현재 요약을 보유하는 변경 가능한 dict-like 속성. update를 호출하면 변경 사항이 유지됩니다.
* `project` (`str`): run과 연결된 프로젝트
* `entity` (`str`): run과 연결된 entity의 이름
* `project_internal_id` (`int`): 프로젝트의 내부 ID
* `user` (`str`): run을 생성한 사용자의 이름
* `path` (`str`): 고유 식별자 \[entity]/\[project]/\[run\_id]
* `notes` (`str`): run에 대한 노트
* `read_only` (`boolean`): run이 편집 가능한지 여부
* `history_keys` (`str`): `wandb.Run.log({"key": "value"})`로 로깅된 이력 메트릭 키
* `metadata` (`str`): wandb-metadata.json의 run에 대한 메타데이터
Properties
run 설정을 조회합니다. 지연 모드인 경우 전체 데이터를 자동으로 로드합니다.
run에 연결된 entity입니다.
run의 고유 식별자입니다.
run의 이력에서 마지막으로 로깅된 step을 반환합니다.
wandb-metadata.json에서 가져온 run에 대한 메타데이터입니다.
메타데이터에는 run의 설명, 태그, 시작 시간, 메모리
사용량 등이 포함됩니다.
run의 이름입니다.
run의 경로입니다. 경로는 entity, 프로젝트, run\_id를 포함하는 목록입니다.
내부 키를 포함한 원시 run 설정을 조회합니다. 지연 모드인 경우 전체 데이터를 자동으로 로드합니다.
run의 상태입니다.
다음 표는 run이 가질 수 있는 상태를 설명합니다:
| 상태 | 설명 |
| - | - |
| Crashed | 내부 프로세스에서 하트비트 전송이 중단된 경우로, 머신이 크래시된 경우 발생할 수 있습니다. |
| Failed | run이 0이 아닌 종료 상태로 종료되었습니다. |
| Finished | run이 종료되고 데이터가 완전히 동기화되었거나 `wandb.Run.finish()`가 호출되었습니다. |
| Killed | run이 완료되기 전에 강제로 중단되었습니다. |
| Running | run이 여전히 실행 중이며 최근에 하트비트를 전송했습니다. |
| Pending | run이 예약되었으나 아직 시작되지 않은 상태입니다(스윕 및 Launch 작업에서 흔히 발생). |
run의 고유 스토리지 식별자입니다.
run summary 메트릭을 조회합니다. 지연 모드인 경우 전체 데이터를 자동으로 로드합니다.
run summary 메트릭을 조회합니다. 지연 모드인 경우 전체 데이터를 자동으로 로드합니다.
이 run에 연결된 스윕입니다. include\_sweeps가 False인 경우 스윕 데이터를 로드합니다.
스윕 이름을 조회합니다. sweepName이 lightweight fragment에 있으므로 항상 사용할 수 있습니다.
run 시스템 메트릭을 조회합니다. 지연 모드인 경우 전체 데이터를 자동으로 로드합니다.
run의 URL입니다.
run URL은 entity, 프로젝트, run\_id에서 생성됩니다. SaaS 사용자의 경우
`https://wandb.ai/entity/project/run_id` 형식입니다.
이 API는 사용 중단되었습니다. `entity`를 대신 사용하세요.
설명이 제공되지 않았습니다.
설명이 제공되지 않았습니다.
설명이 제공되지 않았습니다.
설명이 제공되지 않았습니다.
설명이 제공되지 않았습니다.
방법 Run.console\_logs()
```python theme={"system"}
self, *,
per_page: 'int' = 1000,
last: 'int | None' = None
```
run의 캡처된 콘솔 출력을 조회합니다.
run이 실행 중일 때, W\&B는 해당 프로세스가 stdout과 stderr에 쓰는 내용을 캡처하여 run의 콘솔 로그로 기록합니다. 이는 W\&B App의 run page "Logs" 탭에 표시되는 것과 동일한 로그입니다. 이 방법은 완료된 run과 아직 실행 중인 run 모두에 대해 해당 로그를 다시 읽어옵니다.
인수
요청당 가져올 라인 수입니다. 로그를 처음부터 읽을 때 사용됩니다. `last`가 지정된 경우 무시됩니다.
설정된 경우 단일 요청으로 로그의 마지막 N라인만 가져옵니다. 실행 중인 run을 확인하거나 크래시를 진단할 때 유용합니다. 백엔드가 한 번의 요청으로 반환하는 라인 수에 한도를 두므로, 더 큰 tail은 최신 라인으로 잘려서 반환됩니다.
예외
* `CommError`: 반복 중 요청이 실패할 경우. 처음부터 로그를 조회하려면 W\&B server 0.77 이상이 필요합니다. 이전 서버에서는 마지막 N줄을 조회하세요.
예시
```python theme={"system"}
import wandb
run = wandb.Api().run("entity/project/run_id")
# 전체 로그를 조회합니다. 가장 오래된 줄부터.
for line in run.console_logs():
print(line.content)
# 마지막 100줄만 조회합니다.
for line in run.console_logs(last=100):
print(line.timestamp, line.content)
```
방법 Run.create()
```python theme={"system"}
api: 'public.Api',
run_id: 'str | None' = None,
project: 'str | None' = None,
entity: 'str | None' = None,
state: "Literal['running', 'pending']" = 'running'
```
주어진 프로젝트에 대한 run을 생성합니다.
대부분의 사용 사례에서는 `wandb.init()`을 사용하세요. `wandb.init()`은 run을 생성하고 업데이트하는 데 더 강력한 로직을 제공합니다. `wandb.apis.public.Run.create`는 (예를 들어, GPU가 부족하거나 경합이 심한 Kubernetes 클러스터에서) 스케줄링할 수 없는 작업을 위해 "pending" 상태로 run을 생성하는 등의 특정 시나리오를 위한 것입니다. 이러한 pending run은 나중에 W\&B에서 재개하고 추적할 수 있습니다.
이 방법으로 생성된 run은 기능이 제한적입니다. 이렇게 생성된 run에서 `update()`를 호출하면 예상대로 작동하지 않을 수 있습니다.
인수
The W\&B API 인스턴스.
선택 run ID. 제공되지 않으면 임의의 ID가 생성됩니다.
선택 프로젝트 이름. API 설정의 프로젝트 또는 "uncategorized"로 기본 설정됩니다.
선택 entity (사용자 또는 팀) 이름.
run의 초기 상태. 나중에 재개할 run에는 "pending"을, 즉시 실행에는 "running"을 사용하세요.
예시
나중에 실행하기 위해 대기 중인 run 생성
```python theme={"system"}
import wandb
api = wandb.Api()
run_name = "my-pending-run"
run = Run.create(
api=api,
project="project",
entity="entity",
state="pending",
run_id=run_name,
)
```
이력 파일을 다운로드할 디렉터리입니다.
완전한 이력을 다운로드해야 하는지 여부입니다. true인 경우, run에 아직 parquet 파일로 내보내지 않은 데이터가 포함되어 있으면 IncompleteRunHistoryError가 발생합니다.
예외
* `IncompleteRunHistoryError`: require\_complete\_history가 True이고 run에 아직 parquet 파일로 내보내지 않은 데이터가 포함된 경우.
* `WandbApiFailedError`: 불완전한 이력 이외의 이유로 API 요청이 실패한 경우.
방법 Run.file()
```python theme={"system"}
self,
name: 'str'
```
아티팩트에서 주어진 이름의 파일 경로를 반환합니다.
인수
요청한 파일의 이름입니다.
방법 Run.files()
```python theme={"system"}
self,
names: 'list[str] | None' = None,
pattern: 'str | None' = None,
per_page: 'int' = 50
```
반환값은 run에서 주어진 기준과 일치하는 모든 파일에 대한 `Files` 객체입니다.
주어진 정확한 파일 이름의 목록을 지정하거나, 일치시킬 패턴을 지정할 수 있습니다.
둘 다 제공된 경우, 패턴은 무시됩니다.
인수
요청된 파일의 이름입니다. 비어 있으면 모든 파일을 반환합니다.
W\&B에서 파일을 반환할 때 일치시킬 패턴입니다. 이 패턴은 mySQL의 LIKE 구문을 사용하므로 .json으로 끝나는 모든 파일과 일치시키려면 "%.json"을 사용합니다. names와 pattern이 모두 제공되면 ValueError가 발생합니다.
페이지당 결과 수입니다.
(int, 선택) 반환할 샘플 수
(list, 선택) 특정 키에 대한 메트릭만 반환
(str, 선택) xAxis로 사용할 메트릭. 기본값은 \_step
(bool, 선택) pandas 데이터프레임으로 반환
(str, 선택) 메트릭은 "default", 머신 메트릭은 "system"
방법 Run.load()
```python theme={"system"}
self,
force: 'bool' = False
```
지연 모드 여부에 따라 적절한 프래그먼트를 사용하여 run 데이터를 로드합니다.
인수
True이면 run 데이터가 이미 로드되어 있더라도 서버에서 다시 가져옵니다.
예외
* `RunNotFoundError`: run을 찾을 수 없거나 run 데이터를 로드할 수 없는 경우에 발생합니다.
방법 Run.load\_full\_data()
```python theme={"system"}
self,
force: 'bool' = False
```
config, systemMetrics, summaryMetrics 같은 무거운 필드를 포함한 전체 run 데이터를 로드합니다.
이 방법은 처음에 lazy=True로 run 목록을 조회했지만,
특정 run의 전체 데이터에 액세스해야 할 때 유용합니다.
`wandb.Api().artifact(name)`에서 반환된 아티팩트입니다.
이 아티팩트에 적용할 별칭입니다.
(목록, 선택) 이 아티팩트에 적용할 태그입니다(있는 경우).
방법 Run.logged\_artifacts()
```python theme={"system"}
self,
per_page: 'int' = 100
```
이 run에서 로깅한 모든 아티팩트를 가져옵니다.
run 중에 로깅한 모든 출력 아티팩트를 검색합니다.
순회하거나 하나의 목록으로 모을 수 있는 페이지 매김 결과를 반환합니다.
인수
API 요청 한 번에 가져올 아티팩트 수입니다.
예시
```python theme={"system"}
import wandb
import tempfile
with tempfile.NamedTemporaryFile(mode="w", delete=False, suffix=".txt") as tmp:
tmp.write("This is a test artifact")
tmp_path = tmp.name
run = wandb.init(project="artifact-example")
artifact = wandb.Artifact("test_artifact", type="dataset")
artifact.add_file(tmp_path)
run.log_artifact(artifact)
run.finish()
api = wandb.Api()
finished_run = api.run(f"{run.entity}/{run.project}/{run.id}")
for logged_artifact in finished_run.logged_artifacts():
print(logged_artifact.name)
```
방법 Run.save()
```python theme={"system"}
self
```
run 객체의 변경 사항을 W\&B 백엔드에 저장합니다.
방법 Run.scan\_history()
```python theme={"system"}
self,
keys: 'list[str] | None' = None,
page_size: 'int' = 1000,
min_step: 'int' = 0,
max_step: 'int | None' = None,
use_cache: 'bool' = True
```
run의 모든 이력 레코드로 구성된 순회 가능한 컬렉션을 반환합니다.
인수
run의 이력에서 조회할 메트릭 목록입니다. 스캔은 요청한 키가 모두 포함된 행만 반환합니다. 키가 서로 다른 step에서 로깅되었다면 각 키에 대해 별도로 호출하거나 이 인수를 생략하세요. 키를 제공하지 않으면 모든 메트릭이 반환됩니다.
한 번에 조회할 이력 항목 수입니다.
이력을 조회하기 시작할 최소 step입니다(해당 step 포함).
이력을 조회할 최대 step입니다(해당 step 제외).
True로 설정하면 WANDB\_CACHE\_DIR에서 run 이력을 확인합니다. 캐시에서 run 이력을 찾을 수 없으면 서버에서 다운로드합니다. False로 설정하면 매번 run 이력을 다운로드합니다.
방법 Run.stop()
```python theme={"system"}
self
```
이 run의 정상 종료를 요청합니다.
W\&B 백엔드에서 run의 중지 플래그를 설정하며, 이는
W\&B 앱 UI의 "Stop run" 버튼이 보내는 신호와 동일합니다. run을 실행하는 프로세스는
정기적인 하트비트를 통해 플래그를 확인하고
run을 정상 종료하므로, 원격 run을 종료할 때 안전하게 사용할 수 있습니다
(예: Kubernetes 파드에서 실행되는 run).
중지는 비동기적으로 이루어집니다. 이 방법은 run이 종료될 때가 아니라 백엔드에서
run에 플래그를 설정하면 반환됩니다. 다시 호출하거나
더 이상 실행 중이 아닌 run에서 호출해도 아무런 효과가 없습니다.
예외
* `wandb.Error`: 요청이 실패한 경우.
예시
```python theme={"system"}
import wandb
run = wandb.Api().run("entity/project/run_id")
run.stop()
```
방법 Run.to\_html()
```python theme={"system"}
self,
height: 'int' = 420,
hidden: 'bool' = False
```
이 run을 표시하는 iframe이 포함된 HTML을 생성합니다.
인수
설명이 제공되지 않았습니다.
설명이 제공되지 않았습니다.
방법 Run.update()
```python theme={"system"}
self
```
run 객체의 변경 사항을 wandb 백엔드에 저장합니다.
방법 Run.update\_state()
```python theme={"system"}
self,
state: 'str'
```
run의 상태를 업데이트합니다.
지원되는 상태 전환:
* `running`, `failed`, `crashed` 또는 `preempted`에서 `pending`으로
(예: 종료되었거나 진행 중인 run을 큐에 다시 추가)
* `pending` 또는 `running`에서 `failed`로
(예: 선점되었거나 유실된 run을 실패로 표시)
스윕 run의 상태는 업데이트할 수 없습니다.
가능한 run 상태 목록은 `Run.state`를 참조하세요.
인수
대상 run의 상태입니다. `"pending"` 또는 `"failed"` 중 하나입니다.
예외
* `wandb.Error`: 요청한 상태 전환이 허용되지 않거나 서버가 이 오퍼레이션을 지원하지 않는 경우.
방법 Run.upload\_file()
```python theme={"system"}
self,
path: 'str',
root: 'str' = '.'
```
로컬 파일을 W\&B에 업로드하고 이 run과 연결합니다.
인수
업로드할 파일의 경로입니다. 절대 경로나 상대 경로를 사용할 수 있습니다.
파일을 저장할 때 상대 경로의 기준이 되는 루트 경로입니다. 예를 들어, run에 파일을 "my\_dir/file.txt"로 저장하려고 하고 현재 "my\_dir"에 있다면 root를 "../"로 설정합니다. 기본값은 현재 디렉터리(".")입니다.
`wandb.Api().artifact(name)`에서 반환된 아티팩트
스크립트에서 아티팩트가 어떻게 사용되는지 파악할 수 있는 string입니다. 베타 wandb Launch 기능의 아티팩트 교체 기능을 사용할 때 run에서 사용되는 아티팩트를 쉽게 구분하는 데 사용됩니다.
방법 Run.used\_artifacts()
```python theme={"system"}
self,
per_page: 'int' = 100
```
이 run에서 명시적으로 사용한 아티팩트를 가져옵니다.
run 중에 일반적으로 `run.use_artifact()`를 통해 사용한다고 명시적으로 선언한
입력 아티팩트만 검색합니다. 순회하거나 하나의 목록으로 모을 수 있는
페이지 매김 결과를 반환합니다.
인수
API 요청 한 번에 가져올 아티팩트 수입니다.
예시
```python theme={"system"}
import wandb
run = wandb.init(project="artifact-example")
run.use_artifact("test_artifact:latest")
run.finish()
api = wandb.Api()
finished_run = api.run(f"{run.entity}/{run.project}/{run.id}")
for used_artifact in finished_run.used_artifacts():
print(used_artifact.name)
test_artifact
```
방법 Run.wait\_until\_finished()
```python theme={"system"}
self
```
run이 완료될 때까지 상태를 확인합니다.