컬렉션 어노테이션 추가

컬렉션에 사용자 친화적인 텍스트를 추가하여 Users 가 컬렉션의 목적과 포함된 Artifacts 를 이해하도록 돕습니다.

컬렉션에 따라 트레이닝 데이터, 모델 아키텍처, 태스크, 라이선스, 레퍼런스 및 배포에 대한 정보를 포함할 수 있습니다. 다음은 컬렉션에서 문서화할 가치가 있는 몇 가지 주제입니다:

W&B는 최소한 다음 세부 사항을 포함할 것을 권장합니다:

• Summary: 컬렉션의 목적. 기계학습 실험에 사용된 machine learning 프레임워크.
• License: 기계학습 모델의 사용과 관련된 법적 약관 및 권한. 이는 모델 Users 가 모델을 활용할 수 있는 법적 프레임워크를 이해하는 데 도움이 됩니다. 일반적인 라이선스에는 Apache 2.0, MIT, GPL 등이 있습니다.
• References: 관련 연구 논문, 데이터셋 또는 외부 리소스에 대한 인용 또는 참조.

컬렉션에 트레이닝 데이터가 포함된 경우, 다음 추가 세부 사항을 포함하는 것을 고려하세요:

• Training data: 사용된 트레이닝 데이터에 대한 설명.
• Processing: 트레이닝 데이터셋에 대해 수행된 처리 작업.
• Data storage: 데이터가 저장된 위치와 엑세스 방법.

컬렉션에 기계학습 모델이 포함된 경우, 다음 추가 세부 사항을 포함하는 것을 고려하세요:

• Architecture: 모델 아키텍처, 레이어 및 특정 설계 선택에 대한 정보.
• Task: 컬렉션 모델이 수행하도록 설계된 특정 유형의 작업 또는 문제. 이는 모델의 의도된 기능에 대한 분류입니다.
• Deserialize the model: 팀의 다른 구성원이 모델을 메모리에 로드하는 방법에 대한 정보를 제공합니다.
• Deployment: 모델이 배포된 방법과 위치, 그리고 워크플로우 오케스트레이션 플랫폼과 같은 다른 엔터프라이즈 시스템에 모델을 통합하는 방법에 대한 가이드.

​

컬렉션에 설명 추가하기

W&B Registry UI 또는 Python SDK를 사용하여 대화식 또는 프로그래밍 방식으로 컬렉션에 설명을 추가할 수 있습니다.

W&B Registry UI

1. W&B Registry로 이동합니다.
2. 컬렉션을 클릭합니다.
3. 컬렉션 이름 옆의 View details를 선택합니다.
4. Description 필드 내에 컬렉션에 대한 정보를 제공합니다. 텍스트 형식은 Markdown markup language를 사용하여 지정할 수 있습니다.

Python SDK

wandb.Api().artifact_collection() 메소드를 사용하여 컬렉션의 설명에 엑세스합니다. 반환된 오브젝트의 description 속성을 사용하여 컬렉션에 설명을 추가하거나 업데이트합니다.

type_name 파라미터에는 컬렉션의 유형을 지정하고, name 파라미터에는 컬렉션의 전체 이름을 지정합니다. 컬렉션 이름은 접두사 “wandb-registry”, 레지스트리 이름, 컬렉션 이름이 슬래시(/)로 구분되어 구성됩니다:

wandb-registry-{REGISTRY_NAME}/{COLLECTION_NAME}

다음 코드 조각을 복사하여 Python 스크립트 또는 노트북에 붙여넣으세요. 꺾쇠괄호 (<>)로 묶인 값을 실제 값으로 바꿉니다.

import wandb

api = wandb.Api()

collection = api.artifact_collection(
  type_name = "<collection_type>", 
  name = "<collection_name>"
  )

# 설명 추가
collection.description = "This is a description."
# 저장
collection.save()  

예를 들어, 다음 이미지는 모델의 아키텍처, 의도된 용도, 성능 정보 등을 문서화한 컬렉션을 보여줍니다.