> ## 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.
# Api
export const GitHubLink = ({url, compact = false}) =>
{compact ? "View source" : <>
GitHub source
}
;
`https://api.wandb.ai`가 아닌 다른 W\&B 서버를 사용하는 경우 `base_url`을 설정할 수 있습니다. `entity`, `project`, `run`의 기본값도 설정할 수 있습니다.
API 요청의 HTTP timeout(초)입니다. 지정하지 않으면 기본 timeout이 사용됩니다.
인증에 사용할 API 키입니다. 지정하지 않으면 현재 환경 또는 설정의 API 키가 사용됩니다. API 키를 지정하지 않았고 환경에도 설정되어 있지 않으면 API 키 입력을 요청합니다.
아티팩트의 이름입니다. 아티팩트의 이름은 최소한 아티팩트가 로깅된 프로젝트의 이름, 아티팩트의 이름, 아티팩트의 버전 또는 별칭으로 구성된 파일 경로와 유사합니다. 선택적으로 아티팩트를 로깅한 entity를 접두사로 추가하고 그 뒤에 슬래시(/)를 붙일 수 있습니다. 이름에 entity가 지정되지 않은 경우 run 또는 API 설정의 entity가 사용됩니다.
가져올 아티팩트의 유형입니다.
예외
* `ValueError`: 아티팩트 이름을 지정하지 않은 경우 발생합니다.
* `ValueError`: 지정한 아티팩트 유형이 가져온 아티팩트의 유형과 일치하지 않는 경우 발생합니다.
예시
다음 코드 스니펫에서 "entity", "project", "artifact",
"version", "alias"는 각각 W\&B entity, 아티팩트가 속한
프로젝트의 이름, 아티팩트의 이름,
아티팩트의 버전을 나타내는 자리표시자입니다.
```python theme={"system"}
import wandb
# 프로젝트, 아티팩트 이름, 아티팩트 별칭을 지정합니다
wandb.Api().artifact(name="project/artifact:alias")
# 프로젝트, 아티팩트 이름, 특정 아티팩트 버전을 지정합니다
wandb.Api().artifact(name="project/artifact:version")
# entity, 프로젝트, 아티팩트 이름, 아티팩트 별칭을 지정합니다
wandb.Api().artifact(name="entity/project/artifact:alias")
# entity, 프로젝트, 아티팩트 이름, 특정 아티팩트 버전을 지정합니다
wandb.Api().artifact(name="entity/project/artifact:version")
```
방법 Api.artifact\_collection()
```python theme={"system"}
self,
type_name: 'str',
name: 'str'
```
유형별로 단일 아티팩트 컬렉션을 반환합니다.
반환된 `ArtifactCollection` 객체를 사용하여
해당 컬렉션의 특정 아티팩트에 대한 정보 등을 조회할 수 있습니다.
인수
아티팩트 컬렉션을 가져올 유형입니다.
아티팩트 컬렉션 이름입니다. 선택적으로 아티팩트를 로깅한 entity를 접두사로 추가하고 그 뒤에 슬래시를 붙일 수 있습니다.
예시
다음 코드 스니펫에서 "type", "entity", "project", 그리고
"artifact\_name"은 각각 컬렉션 유형, W\&B
entity, 아티팩트가 속한 프로젝트의 이름, 그리고
아티팩트의 이름을 나타내는 자리표시자입니다.
```python theme={"system"}
import wandb
collections = wandb.Api().artifact_collection(
type_name="type", name="entity/project/artifact_name"
)
# 컬렉션에서 첫 번째 아티팩트를 조회합니다.
artifact_example = collections.artifacts()[0]
# 아티팩트의 내용을 지정된 루트 디렉터리에 다운로드합니다.
artifact_example.download()
```
방법 Api.artifact\_collection\_exists()
```python theme={"system"}
self,
name: 'str',
type: 'str'
```
지정된 프로젝트와 entity 내에 아티팩트 컬렉션이 존재하는지 여부.
인수
아티팩트 컬렉션 이름입니다. 선택적으로, 아티팩트를 로깅한 entity를 접두사로 추가하고 슬래시(/)를 붙일 수 있습니다. entity 또는 프로젝트가 지정되지 않은 경우, override params가 존재하면 컬렉션을 추론합니다. 그렇지 않으면 entity는 사용자 설정에서 가져오고, 프로젝트는 기본적으로 "uncategorized"로 설정됩니다.
아티팩트 컬렉션의 유형입니다.
예시
위 코드 스니펫에서 "type"과 "collection\_name"은 각각 아티팩트 컬렉션의 유형과
컬렉션의 이름을 가리킵니다.
```python theme={"system"}
import wandb
wandb.Api.artifact_collection_exists(type="type", name="collection_name")
```
필터링할 프로젝트의 이름입니다.
필터링할 아티팩트 유형의 이름입니다.
결과의 순서를 지정하는 선택 string입니다. '+'로 시작하면 오름차순(기본값)으로 정렬하고, '-'로 시작하면 내림차순으로 정렬합니다.
쿼리 페이지 매김의 페이지 크기를 설정합니다. 보통 변경할 이유가 없습니다.
이전 쿼리를 재개하기 위한 페이지 매김 커서로, 이전 paginator의 `.cursor` 속성에서 캡처합니다.
방법 Api.artifact\_exists()
```python theme={"system"}
self,
name: 'str',
type: 'str | None' = None
```
지정된 프로젝트와 entity에 아티팩트 버전이 존재하는지 여부.
인수
아티팩트의 이름입니다. 아티팩트의 entity와 프로젝트를 접두사로 추가하세요. 아티팩트의 버전 또는 별칭을 콜론으로 추가하세요. entity 또는 프로젝트가 지정되지 않은 경우, W\&B는 채워져 있으면 override 매개변수를 사용합니다. 그렇지 않으면 entity는 사용자 설정에서 가져오고 프로젝트는 "Uncategorized"로 설정됩니다.
아티팩트의 유형입니다.
예시
다음 코드 스니펫에서 "entity", "project", "artifact",
"version", "alias"는 각각 사용자의 W\&B entity,
아티팩트가 속한 프로젝트의 이름, 아티팩트의 이름,
아티팩트의 버전을 나타내는 자리표시자입니다.
```python theme={"system"}
import wandb
wandb.Api().artifact_exists("entity/project/artifact:version")
wandb.Api().artifact_exists("entity/project/artifact:alias")
```
가져올 아티팩트의 유형입니다.
아티팩트의 컬렉션 이름입니다. 선택적으로 아티팩트를 로깅한 entity 뒤에 슬래시(/)를 붙여 접두사로 추가할 수 있습니다.
결과의 정렬 순서를 지정하는 선택적 string입니다. '+'로 시작하면 오름차순(기본값)으로 정렬합니다. '-'로 시작하면 내림차순으로 정렬합니다.
쿼리 페이지 매김의 페이지 크기를 설정합니다. 일반적으로 변경할 필요가 없습니다.
이 태그를 모두 가진 아티팩트만 반환합니다.
이전 쿼리를 재개하기 위한 페이지 매김 커서로, 이전 paginator의 `.cursor` 속성에서 캡처한 값입니다.
예시
다음 코드 스니펫에서 "type", "entity", "project",
"artifact\_name"은 각각 아티팩트 유형, W\&B entity,
아티팩트가 로깅된 프로젝트의 이름,
아티팩트의 이름을 나타내는 자리 표시자입니다.
```python theme={"system"}
import wandb
wandb.Api().artifacts(type_name="type", name="entity/project/artifact_name")
```
반복을 일시 중지하고 나중에 동일한 위치에서 재개하려면
paginator의 `.cursor`를 저장하고 이를 `start=`로 전달하세요:
```python theme={"system"}
from itertools import islice
import wandb
api = wandb.Api()
# 첫 번째 결과 페이지를 소비한 후 커서를 저장합니다.
page_size = 10
artifacts = api.artifacts(
type_name="type",
name="entity/project/artifact_name",
per_page=page_size,
)
first_page = list(islice(artifacts, page_size))
saved_cursor = artifacts.cursor
# 나중에 (예: 새 프로세스에서) 저장된 커서에서 반복을 재개합니다.
remaining_artifacts = api.artifacts(
type_name="type",
name="entity/project/artifact_name",
per_page=page_size,
start=saved_cursor,
)
```
방법 Api.automation()
```python theme={"system"}
self,
name: 'str', *,
entity: 'str | None' = None
```
매개변수와 일치하는 유일한 자동화를 반환합니다.
인수
가져올 자동화의 이름입니다.
자동화를 가져올 entity입니다.
예외
* `ValueError`: 0개 또는 여러 자동화가 검색 기준과 일치하는 경우.
예시
"my-automation"이라는 기존 자동화를 조회하세요:
```python theme={"system"}
import wandb
api = wandb.Api()
automation = api.automation(name="my-automation")
```
entity "my-team"에서 "other-automation"이라는 이름의 기존 자동화를 조회합니다:
```python theme={"system"}
automation = api.automation(name="other-automation", entity="my-team")
```
방법 Api.automations()
```python theme={"system"}
self,
entity: 'str | None' = None, *,
name: 'str | None' = None,
per_page: 'int' = 50,
start: 'str | None' = None
```
주어진 매개변수와 일치하는 모든 자동화를 순회하는 반복자를 반환합니다.
매개변수가 제공되지 않으면 반환된 반복자에는 사용자가 액세스할 수 있는 모든
자동화가 포함됩니다.
인수
자동화를 가져올 entity입니다.
가져올 자동화의 이름입니다.
페이지당 가져올 자동화의 수입니다. 기본값은 50입니다. 일반적으로 이 값을 변경할 필요는 없습니다.
이전 쿼리를 재개하기 위한 페이지 매김 커서로, 이전 paginator의 `.cursor` 속성에서 캡처한 값입니다.
예시
entity "my-team"의 기존 자동화를 모두 가져옵니다:
```python theme={"system"}
import wandb
api = wandb.Api()
automations = api.automations(entity="my-team")
```
차트를 소유한 entity(사용자 또는 팀)
차트 프리셋의 고유 식별자
UI에 표시되는 사람이 읽기 쉬운 이름
사양의 유형입니다. Vega-Lite v2 사양의 경우 "vega2"여야 합니다.
차트의 액세스 수준:
* "private": 차트를 생성한 entity만 차트에 액세스할 수 있습니다
* "public": 누구나 차트에 액세스할 수 있습니다
딕셔너리 또는 JSON string으로 표현된 Vega/Vega-Lite 사양
예외
* `wandb.Error`: 차트 생성에 실패한 경우
* `UnsupportedError`: 서버가 맞춤형 차트를 지원하지 않는 경우
레지스트리의 이름입니다. 이름은 조직 내에서 고유해야 합니다.
레지스트리의 공개 범위입니다. organization: 조직의 누구나 이 레지스트리를 볼 수 있습니다. 나중에 UI의 설정에서 역할을 편집할 수 있습니다. restricted: UI를 통해 초대된 구성원만 이 레지스트리에 액세스할 수 있습니다. 공개 공유는 비활성화됩니다.
레지스트리의 조직입니다. 설정에 조직이 지정되지 않은 경우, entity가 하나의 조직에만 속해 있다면 entity에서 조직을 가져옵니다.
레지스트리의 설명입니다.
레지스트리의 수락된 아티팩트 유형입니다. 유형은 128자를 초과할 수 없으며 `/` 또는 `:` 문자를 포함하지 않아야 합니다. 지정되지 않은 경우 모든 유형이 수락됩니다. 레지스트리에 추가된 허용된 유형은 나중에 제거할 수 없습니다.
예시
```python theme={"system"}
import wandb
api = wandb.Api()
registry = api.create_registry(
name="my-registry",
visibility="restricted",
organization="my-org",
description="This is a test registry",
artifact_types=["model"],
)
```
run에 부여할 ID입니다. 지정하지 않으면 W\&B가 임의의 ID를 생성합니다.
run을 로깅할 프로젝트입니다. 프로젝트를 지정하지 않으면 "Uncategorized"라는 프로젝트에 run을 로깅합니다.
프로젝트를 소유한 entity입니다. entity를 지정하지 않으면 기본 entity에 run을 로깅합니다.
생성할 큐의 이름
큐에 사용할 리소스 유형입니다. "local-container", "local-process", "kubernetes","sagemaker" 또는 "gcp-vertex" 중 하나입니다.
큐를 생성할 entity의 이름입니다. `None`이면 설정된 entity 또는 기본 entity를 사용합니다.
사용할 우선순위 지정 버전입니다. "V0" 또는 `None`입니다.
큐에 사용할 기본 리소스 설정입니다. 템플릿 변수를 지정하려면 handlebars(예: `{{var}}`)를 사용하세요.
설정과 함께 사용할 템플릿 변수 스키마의 딕셔너리입니다.
방법 Api.create\_team()
```python theme={"system"}
self,
team: 'str',
admin_username: 'str | None' = None
```
새 팀을 생성합니다.
W\&B Multi-tenant Cloud 사용자는 `create_team()`을 호출하기 전에
W\&B UI의 사용자 설정에서 Default API organization을 설정하세요.
이 설정을 통해 새 팀이 속할 조직을 확인합니다.
인수
팀의 이름입니다.
팀의 Admin 사용자의 사용자 이름입니다. 기본값은 현재 사용자입니다.
```python theme={"system"}
(self)
```
로컬 캐시를 플러시합니다.
api 객체는 run의 로컬 캐시를 유지하므로, 스크립트 실행 중 run의 상태가
변경될 수 있다면 로컬 캐시를 지워야 합니다.
`api.flush()`를 사용하면 run에 연결된 최신 값을 조회할 수 있습니다.
방법 Api.from\_path()
```python theme={"system"}
(self,
path: 'str')
```
경로에서 run, 스윕, 프로젝트 또는 보고서를 반환합니다.
인수
프로젝트, run, 스윕 또는 보고서의 경로
예시
다음 코드 스니펫에서 "project", "team", "run\_id", "sweep\_id",
및 "report\_name"은 각각 프로젝트, 팀, run ID,
스윕 ID 및 특정 보고서의 이름을 나타내는 자리표시자입니다.
```python theme={"system"}
import wandb
api = wandb.Api()
project = api.from_path("project")
team_project = api.from_path("team/project")
run = api.from_path("team/project/runs/run_id")
sweep = api.from_path("team/project/sweeps/sweep_id")
report = api.from_path("team/project/reports/report_name")
```
방법 Api.integrations()
```python theme={"system"}
self,
entity: 'str | None' = None, *,
per_page: 'int' = 50,
start: 'str | None' = None
```
entity의 모든 인테그레이션에 대한 이터레이터를 반환합니다.
인수
인테그레이션을 가져올 entity(예: 팀 이름)입니다. 지정하지 않으면 사용자의 기본 entity가 사용됩니다.
페이지당 가져올 인테그레이션 수입니다. 기본값은 50입니다. 일반적으로 이 값을 변경할 필요는 없습니다.
제공된 설명이 없습니다.
```python theme={"system"}
self,
name: 'str',
entity: 'str | None' = None
```
지정한 이름(및 entity가 지정된 경우 해당 entity)의 `Project`를 반환합니다.
인수
프로젝트 이름입니다.
요청한 entity의 이름입니다. None이면 `Api`에 전달된 기본 entity를 사용합니다. 기본 entity가 없으면 `ValueError`가 발생합니다.
방법 Api.projects()
```python theme={"system"}
self,
entity: 'str | None' = None,
per_page: 'int' = 200
```
지정된 entity의 프로젝트를 조회합니다.
인수
요청한 entity의 이름입니다. None이면 `Api`에 전달된 기본 entity를 사용합니다. 기본 entity가 없으면 `ValueError`가 발생합니다.
쿼리 페이지 매김의 페이지 크기를 설정합니다. 일반적으로 이 값을 변경할 필요는 없습니다.
방법 Api.queued\_run()
```python theme={"system"}
(self,
entity: 'str',
project: 'str',
queue_name: 'str',
run_queue_item_id: 'str', project_queue=None, priority=None)
```
경로를 기반으로 큐에서 대기 중인 단일 run을 반환합니다.
`entity/project/queue_id/run_queue_item_id` 형식의 경로를 파싱합니다.
인수
제공된 설명이 없습니다.
제공된 설명이 없습니다.
제공된 설명이 없습니다.
제공된 설명이 없습니다.
제공된 설명이 없습니다.
제공된 설명이 없습니다.
방법 Api.registries()
```python theme={"system"}
self,
organization: 'str | None' = None,
filter: 'dict[str, Any] | None' = None,
order: 'str | None' = None,
per_page: 'int' = 100,
start: 'str | None' = None
```
`Registry` 객체의 지연 이터레이터를 반환합니다.
이터레이터를 사용하여 조직의 레지스트리 전반에서 레지스트리, 컬렉션,
또는 아티팩트 버전을 검색하고 필터링하세요. 결과는
순회할 때 지연 방식으로 가져오므로 원하는 개수의
항목을 가져온 뒤(예를 들어 :func:`itertools.islice` 사용) 나머지를 요청하지
않고 중단할 수 있습니다.
인수
가져올 레지스트리가 속한 조직입니다. 지정하지 않으면 사용자 설정에 지정된 조직을 사용합니다.
지연 레지스트리 이터레이터의 각 객체에 적용할 선택적 MongoDB 스타일 필터입니다. 레지스트리 필터링에 사용 가능한 필드는 `name`, `description`, `created_at`, `updated_at`입니다. 컬렉션 필터링에 사용 가능한 필드는 `name`, `tag`, `description`, `created_at`, `updated_at`입니다. 버전 필터링에 사용 가능한 필드는 `tag`, `alias`, `created_at`, `updated_at`, `metadata`입니다.
결과의 정렬 순서를 지정하는 선택적 string입니다. 접두사가 '+'이면 오름차순으로 정렬합니다(기본값). 접두사가 '-'이면 내림차순으로 정렬합니다.
쿼리 페이지 매김의 페이지 크기를 설정합니다.
이전 쿼리를 재개하기 위한 페이지 매김 커서로, 이전 페이지네이터의 `.cursor` 속성에서 캡처한 값입니다.
예시
이름에 "model"이 포함된 모든 레지스트리 찾기
```python theme={"system"}
import wandb
api = wandb.Api() # entity가 여러 조직에 속한 경우 조직을 지정하세요
api.registries(filter={"name": {"$regex": "model"}})
```
레지스트리에서 이름이 "my\_collection"이고 태그가 "my\_tag"인 모든 컬렉션을 찾으세요.
```python theme={"system"}
api.registries().collections(filter={"name": "my_collection", "tag": "my_tag"})
```
레지스트리에서 컬렉션 이름에 "my\_collection"이 포함되고 버전에 "best" 별칭이 있는 모든 아티팩트 버전을 찾습니다.
```python theme={"system"}
api.registries().collections(
filter={"name": {"$regex": "my_collection"}}
).versions(filter={"alias": "best"})
```
"model"을 포함하는 레지스트리에서 "prod" 태그 또는 "best" 별칭이 있는 모든 아티팩트 버전을 찾습니다.
```python theme={"system"}
api.registries(filter={"name": {"$regex": "model"}}).versions(
filter={"$or": [{"tag": "prod"}, {"alias": "best"}]}
)
```
페이지네이터의 `.cursor`를 저장하고 `start=`로 전달하여
순회를 일시 중지하고 나중에 같은 위치에서 재개하세요:
```python theme={"system"}
from itertools import islice
import wandb
api = wandb.Api()
# 결과의 첫 페이지를 읽은 다음 커서를 저장하세요.
page_size = 10
registries = api.registries(per_page=page_size)
first_page = list(islice(registries, page_size))
saved_cursor = registries.cursor
# 나중에(예: 새 프로세스에서) 저장된 커서부터 순회를 재개하세요.
remaining_registries = api.registries(per_page=page_size, start=saved_cursor)
```
방법 Api.registry()
```python theme={"system"}
self,
name: 'str',
organization: 'str | None' = None
```
지정된 레지스트리 이름에 해당하는 레지스트리를 반환합니다.
인수
레지스트리의 이름입니다. `wandb-registry-` 접두사는 제외합니다.
레지스트리의 조직입니다. 설정에 조직이 지정되어 있지 않고 entity가 하나의 조직에만 속한 경우, entity에서 조직을 가져옵니다.
예시
레지스트리 조회 및 업데이트
```python theme={"system"}
import wandb
api = wandb.Api()
registry = api.registry(name="my-registry", organization="my-org")
registry.description = "This is an updated description"
registry.save()
```
방법 Api.reports()
```python theme={"system"}
self,
path: 'str' = '',
name: 'str | None' = None,
per_page: 'int' = 50
```
지정된 프로젝트 경로의 보고서를 조회합니다.
참고: `wandb.Api.reports()` API는 베타 버전이며 향후 릴리스에서
변경될 수 있습니다.
인수
보고서가 있는 프로젝트의 경로입니다. 프로젝트를 생성한 entity를 접두사로 지정하고 그 뒤에 슬래시를 붙이세요.
요청한 보고서의 이름입니다.
쿼리 페이지 매김의 페이지 크기를 설정합니다. 일반적으로 이 값을 변경할 필요는 없습니다.
```python theme={"system"}
self,
path: 'str' = ''
```
`entity/project/run_id` 형식의 경로를 파싱하여 단일 run을 반환합니다.
인수
`entity/project/run_id` 형식의 run 경로입니다. `api.entity`가 설정되어 있으면 `project/run_id` 형식을 사용할 수 있으며, `api.project`가 설정되어 있으면 run\_id만 사용할 수 있습니다.
예외
* `RunNotFoundError`: run을 찾을 수 없거나 run 데이터를 로드할 수 없는 경우.
방법 Api.run\_queue()
```python theme={"system"}
(self,
entity: 'str',
name: 'str')
```
entity의 지정된 이름을 가진 `RunQueue`를 반환합니다.
run 큐를 만드는 방법에 대한 자세한 내용은 `Api.create_run_queue`를 참조하세요.
인수
설명이 제공되지 않았습니다.
설명이 제공되지 않았습니다.
방법 Api.runs()
```python theme={"system"}
(self,
path: 'str | None' = None,
filters: 'dict[str, Any] | None' = None,
order: 'str' = '+created_at',
per_page: 'int' = 50,
include_sweeps: 'bool' = False,
lazy: 'bool' = True)
```
`Run` 객체를 지연 순회하는 `Runs` 객체를 반환합니다.
필터링할 수 있는 필드는 다음과 같습니다:
* `createdAt`: run이 생성된 타임스탬프입니다. (ISO 8601 형식, 예: "2023-01-01T12:00:00Z")
* `displayName`: 사람이 읽기 쉬운 run의 표시 이름입니다. (예: "eager-fox-1")
* `duration`: run의 총 실행 시간(초)입니다.
* `group`: 관련 run을 함께 정리하는 데 사용하는 그룹 이름입니다.
* `host`: run이 실행된 호스트 이름입니다.
* `jobType`: 작업 유형 또는 run의 목적입니다.
* `name`: run의 고유 식별자입니다. (예: "a1b2cdef")
* `state`: run의 현재 상태입니다.
* `tags`: run과 연결된 태그입니다.
* `username`: run을 시작한 사용자의 사용자 이름입니다
또한 run 설정이나 summary 메트릭의 항목으로 필터링할 수 있습니다.
예를 들어 `config.experiment_name`, `summary_metrics.loss` 등이 있습니다.
더 복잡한 필터링에는 MongoDB 쿼리 Operator를 사용할 수 있습니다.
자세한 내용은 다음을 참조하세요: [https://docs.mongodb.com/manual/reference/operator/query](https://docs.mongodb.com/manual/reference/operator/query)
다음 오퍼레이션이 지원됩니다:
* `$and`
* `$or`
* `$nor`
* `$eq`
* `$ne`
* `$gt`
* `$gte`
* `$lt`
* `$lte`
* `$in`
* `$nin`
* `$exists`
* `$regex`
인수
(str) 프로젝트 경로로, "entity/project" 형식이어야 합니다.
(dict) MongoDB 쿼리 언어를 사용하여 특정 run을 조회하는 쿼리입니다. config.key, summary\_metrics.key, state, entity, createdAt 등의 run 속성으로 필터링할 수 있습니다. 예를 들어 `{"config.experiment_name": "foo"}`는 설정 항목의 실험 이름이 "foo"로 설정된 run을 찾습니다.
(str) 정렬 기준은 `created_at`, `heartbeat_at`, `config.*.value` 또는 `summary_metrics.*`일 수 있습니다. 정렬 기준 앞에 +를 붙이면 오름차순으로 정렬됩니다(기본값). 정렬 기준 앞에 -를 붙이면 내림차순으로 정렬됩니다. 기본 정렬 기준은 run.created\_at이며, 오래된 순서에서 최신 순서로 정렬됩니다.
(int) 쿼리 페이지 매김에 사용할 페이지 크기를 설정합니다.
(bool) 각 run 결과의 스윕 객체를 즉시 가져올지 여부입니다.
(bool) 성능 향상을 위해 지연 로딩을 사용할지 여부입니다. True(기본값)이면 처음에는 필수 run 메타데이터만 로드됩니다. config, summaryMetrics, systemMetrics와 같이 용량이 큰 필드는 액세스할 때 필요에 따라 로드됩니다. 처음부터 전체 데이터를 로드하려면 False로 설정하세요.
예시
```python theme={"system"}
import wandb
from wandb.apis.public import Api
# 프로젝트에서 config.experiment_name이 "foo"로 설정된 run을 찾습니다
Api.runs(path="my_entity/project", filters={"config.experiment_name": "foo"})
```
```python theme={"system"}
# 프로젝트에서 config.experiment_name이 "foo" 또는 "bar"로 설정된 run을 찾습니다
Api.runs(
path="my_entity/project",
filters={
"$or": [
{"config.experiment_name": "foo"},
{"config.experiment_name": "bar"},
]
},
)
```
```python theme={"system"}
# 프로젝트에서 config.experiment_name이 정규 표현식과 일치하는 run을 찾습니다
Api.runs(
path="my_entity/project",
filters={"config.experiment_name": {"$regex": "b.*"}},
)
```
참고:
정규 표현식은 Google의 RE2 구문을 사용합니다:
[https://github.com/google/re2/wiki/Syntax](https://github.com/google/re2/wiki/Syntax)
```python theme={"system"}
# 프로젝트에서 run 이름이 정규 표현식과 일치하는 run을 찾습니다
Api.runs(
path="my_entity/project", filters={"display_name": {"$regex": "^foo.*"}}
)
```
```python theme={"system"}
# 프로젝트에서 손실을 기준으로 오름차순 정렬된 run을 찾습니다
Api.runs(path="my_entity/project", order="+summary_metrics.loss")
```
인테그레이션을 가져올 entity(예: 팀 이름)입니다. 지정하지 않으면 사용자의 기본 entity가 사용됩니다.
페이지당 가져올 인테그레이션 수입니다. 기본값은 50입니다. 일반적으로 이 값을 변경할 필요는 없습니다.
제공된 설명이 없습니다.
예시
"my-team" 팀에 등록된 모든 Slack 인테그레이션을 조회합니다:
```python theme={"system"}
import wandb
api = wandb.Api()
slack_integrations = api.slack_integrations(entity="my-team")
```
채널 이름이 "team-alerts-"로 시작하는 채널에 게시하는 Slack 인테그레이션만 찾으세요:
```python theme={"system"}
slack_integrations = api.slack_integrations(entity="my-team")
team_alert_integrations = [
ig
for ig in slack_integrations
if ig.channel_name.startswith("team-alerts-")
]
```
방법 Api.sweep()
```python theme={"system"}
(self, path='')
```
`entity/project/sweep_id` 형식의 경로를 파싱하여 스윕을 반환합니다.
인수
entity/project/sweep\_id 형식의 스윕 경로입니다. `api.entity`가 설정되어 있으면 project/sweep\_id 형식으로 지정할 수 있으며, `api.project`가 설정되어 있으면 sweep\_id만 지정할 수 있습니다.
생성할 큐의 이름
큐에 사용할 기본 리소스 설정(선택 사항)입니다. 템플릿 변수를 지정하려면 handlebars(예: `{{var}}`)를 사용하세요.
큐에 사용할 리소스 유형입니다. "local-container", "local-process", "kubernetes", "sagemaker", "gcp-vertex" 중 하나입니다.
큐를 생성할 entity의 이름(선택 사항)입니다. `None`이면 설정된 entity 또는 기본 entity를 사용합니다.
설정에 사용할 템플릿 변수 스키마의 딕셔너리입니다.
큐에 사용할 외부 링크의 딕셔너리(선택 사항)입니다.
사용할 우선순위 지정 버전(선택 사항)입니다. "V0" 또는 None입니다
방법 Api.user()
```python theme={"system"}
self,
username_or_email: 'str'
```
사용자 이름 또는 이메일 주소로 사용자를 반환합니다.
이 함수는 로컬 관리자만 사용할 수 있습니다. `api.viewer`를 사용하여
자신의 사용자 객체를 조회하세요.
인수
사용자의 사용자 이름 또는 이메일 주소입니다.
방법 Api.users()
```python theme={"system"}
self,
username_or_email: 'str'
```
사용자 이름 또는 이메일 주소의 일부를 쿼리하여 모든 사용자를 반환합니다.
이 함수는 로컬 관리자만 사용할 수 있습니다. `api.viewer`를 사용하여
자신의 사용자 객체를 조회하세요.