Public API Overview - Weights & Biases Documentation

W&B Public API는 W&B에 저장된 데이터를 프로그래밍 방식으로 쿼리, 내보내기, 업데이트할 수 있도록 지원합니다. 이 API는 사후 분석, 데이터 내보내기, 그리고 run, 아티팩트, sweep의 프로그래밍 방식 관리에 사용하세요. 기본 SDK가 트레이닝 중 실시간 logging을 처리하는 반면, Public API를 사용하면 과거 데이터를 조회하고, 메타데이터를 업데이트하고, 아티팩트를 관리하고, 완료된 실험을 분석할 수 있습니다. 기본 Api 클래스는 대부분의 기능에 접근하는 진입점입니다.

모델을 트레이닝하고 파인튜닝하려면 the W&B Python SDK를 사용하세요. 데이터가 W&B에 로깅된 후 이를 쿼리하고 관리하려면 Public API를 사용하세요.

사용 가능한 컴포넌트

컴포넌트	설명
`Api`	Public API의 기본 진입점입니다. 조직 전체에서 run, 프로젝트, 아티팩트를 쿼리합니다.
`Runs`	이력, 로그, 메트릭을 포함한 개별 트레이닝 run에 액세스하고 관리합니다.
`Artifacts`	모델 아티팩트, 데이터셋, 기타 버전 관리되는 파일을 쿼리하고 다운로드합니다.
`Sweeps`	하이퍼파라미터 sweep 데이터에 액세스하고 최적화 결과를 분석합니다.
`Projects`	프로젝트를 관리하고 프로젝트 수준의 메타데이터와 설정에 액세스합니다.
`Reports`	프로그래밍 방식으로 W&B Reports에 액세스하고 관리합니다.
`Team`	팀 정보를 쿼리하고 팀 수준 리소스를 관리합니다.
`User`	사용자 프로필과 사용자별 데이터에 액세스합니다.
`Files`	run과 연결된 파일을 다운로드하고 관리합니다.
`History`	트레이닝 중 로깅된 상세 시계열 메트릭에 액세스합니다(`Run.history` 참조).
`Automations`	자동화된 워크플로와 작업을 관리합니다.
`Integrations`	타사 인테그레이션을 구성하고 관리합니다.

일반적인 활용 사례

데이터 내보내기 및 분석

Jupyter 노트북에서 분석할 수 있도록 run 이력을 데이터프레임으로 내보내기
맞춤형 시각화 또는 보고를 위해 메트릭 다운로드
여러 실험의 결과 집계

사후 업데이트

완료 후 run 메타데이터를 업데이트
완료된 실험에 tags 또는 notes 추가
run 설정 또는 요약 수정

아티팩트 관리

버전 또는 alias로 아티팩트 쿼리
프로그래밍 방식으로 모델 체크포인트 다운로드
아티팩트 리니지와 의존성 추적

Sweep 분석

Sweep 결과와 성능이 가장 좋은 run 확인
하이퍼파라미터 검색 결과 내보내기
파라미터 중요도 분석

인증

Public API는 Python SDK와 동일한 인증 방식을 사용합니다. 다음과 같은 여러 방법으로 인증할 수 있습니다: WANDB_API_KEY 환경 변수를 사용해 API 키를 설정합니다:

export WANDB_API_KEY=your_api_key

Api 클래스를 초기화할 때 API 키를 직접 전달하세요:

api = Api(api_key="your_api_key")

또는 현재 세션을 인증하려면 wandb.login()을 사용하세요:

import wandb

wandb.login()
api = Api()

사용 예시

이름과 alias를 사용해 아티팩트 다운로드하기

다음 예제에서는 이름과 alias를 사용해 W&B에 로깅된 아티팩트를 조회한 뒤, 그 내용을 다운로드하는 방법을 보여줍니다.

import wandb

api = wandb.Api()
artifact = api.artifact("entity/project/artifact:alias")
artifact.download()

레지스트리에서 아티팩트 다운로드

다음 예제에서는 W&B 레지스트리에 연결된 아티팩트를 조회하는 방법을 보여줍니다

import wandb

REGISTRY = "<registry_name>"
COLLECTION = "<collection_name>"
VERSION = "<version>"

api = wandb.Api()
artifact_name = f"wandb-registry-{REGISTRY}/{COLLECTION}:{VERSION}"

# 아티팩트 가져오기
fetched_artifact = api.artifact(name = artifact_name)

# 아티팩트 다운로드. 다운로드된 콘텐츠의 경로 반환
downloaded_path = fetched_artifact.download()

W&B 레지스트리 쿼리

Mongo와 유사한 필터를 사용해 W&B 레지스트리, 컬렉션, Artifacts를 쿼리할 수 있습니다. 다음 예제는 정규식을 사용해 이름을 기준으로 컬렉션을 필터링하는 방법을 보여줍니다.

import wandb

# wandb API 초기화
api = wandb.Api()

# 레지스트리에 관계없이 컬렉션 이름에 `yolo` 문자열이
# 포함된 모든 컬렉션 필터링
collection_filters = {
    "name": {"$regex": "yolo"}
}

# 필터 조건에 맞는 모든 컬렉션의 이터러블 반환
collections = api.registries().collections(filter=collection_filters)

레지스트리, 컬렉션 또는 아티팩트를 쿼리하는 방법에 대한 자세한 내용은 레지스트리 항목 찾기를 참조하세요.

​사용 가능한 컴포넌트

​일반적인 활용 사례

​데이터 내보내기 및 분석

​사후 업데이트

​아티팩트 관리

​Sweep 분석

​인증

​사용 예시

​이름과 alias를 사용해 아티팩트 다운로드하기

​레지스트리에서 아티팩트 다운로드

​W&B 레지스트리 쿼리