> ## 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.
# 컬렉션 설명 작성
> 사용자가 목적과 내용을 이해할 수 있도록 W&B Registry 컬렉션에 설명과 문서를 추가합니다.
사용자가 컬렉션의 목적과 포함된 artifact를 이해할 수 있도록 컬렉션에 사람이 읽기 쉬운 설명을 추가하세요.
컬렉션에 따라 트레이닝 데이터, 모델 아키텍처, 작업, 라이선스, 레퍼런스, 배포에 대한 정보를 포함할 수 있습니다. 다음은 컬렉션에 문서화해 두면 좋은 몇 가지 주제입니다:
W\&B는 최소한 다음 세부 정보를 포함할 것을 권장합니다:
* **Summary**: 컬렉션의 목적과 머신 러닝 실험에 사용된 머신 러닝 프레임워크입니다.
* **License**: 머신 러닝 모델 사용과 관련된 법적 조건 및 권한입니다. 이를 통해 모델 사용자는 해당 모델을 어떤 법적 체계에서 활용할 수 있는지 이해할 수 있습니다. 일반적인 라이선스로는 Apache 2.0, MIT, GPL이 있습니다.
* **References**: 관련 연구 논문, Datasets, 또는 외부 리소스에 대한 인용이나 참조입니다.
컬렉션에 트레이닝 데이터가 포함되어 있다면, 다음과 같은 추가 세부 정보도 포함하는 것을 고려하세요:
* **Training data**: 사용한 트레이닝 데이터를 설명합니다.
* **Processing**: 트레이닝 데이터셋에 수행한 처리 작업입니다.
* **Data storage**: 해당 데이터가 저장된 위치와 액세스 방법입니다.
컬렉션에 머신 러닝 모델이 포함되어 있다면, 다음과 같은 추가 세부 정보도 포함하는 것을 고려하세요:
* **Architecture**: 모델 아키텍처, 레이어, 그리고 특정 설계 선택에 대한 정보입니다.
* **Task**: 컬렉션의 모델이 수행하도록 설계된 작업 또는 문제의 구체적인 유형입니다. 즉, 모델이 의도한 기능을 분류한 것입니다.
* **Deserialize the model**: 팀원이 모델을 메모리에 로드하는 방법에 대한 정보입니다.
* **Deployment**: 모델이 어떻게, 어디에 배포되는지에 대한 세부 정보와 워크플로 오케스트레이션 플랫폼 같은 다른 엔터프라이즈 시스템에 모델을 어떻게 통합하는지에 대한 안내입니다.
## 컬렉션에 설명 추가하기
W\&B Registry UI 또는 Python SDK를 사용해 대화형으로 또는 프로그래밍 방식으로 컬렉션에 설명을 추가할 수 있습니다.
1. [W\&B Registry](https://wandb.ai/registry/)로 이동합니다.
2. 컬렉션을 클릭합니다.
3. 컬렉션 이름 옆의 **View details**를 선택합니다.
4. **설명** 필드에 컬렉션에 대한 정보를 입력합니다. 입력한 텍스트는 [Markdown 마크업 언어](https://www.markdownguide.org/)로 서식을 지정할 수 있습니다.
[`wandb.Api().artifact_collection()`](/ko/models/ref/python/public-api/api#artifact_collection) 메서드를 사용해 컬렉션의 설명에 액세스합니다. 반환된 객체의 `description` 속성을 사용해 컬렉션에 설명을 추가하거나 업데이트합니다.
`type_name` 매개변수에는 컬렉션의 유형을, `name` 매개변수에는 컬렉션의 전체 이름을 지정합니다. 컬렉션 이름은 “wandb-registry” 접두사, 레지스트리 이름, 그리고 슬래시로 구분된 컬렉션 이름으로 구성됩니다:
```text theme={null}
wandb-registry-{REGISTRY_NAME}/{COLLECTION_NAME}
```
다음 코드 스니펫을 Python script or notebook에 복사하여 붙여넣습니다. 꺾쇠괄호(`<>`)로 묶인 값은 사용자 환경에 맞게 바꾸세요.
```python theme={null}
import wandb
api = wandb.Api()
collection = api.artifact_collection(
type_name = "",
name = ""
)
collection.description = "This is a description."
collection.save()
```
예를 들어, 다음 이미지는 모델의 아키텍처, 용도, 성능 정보 등을 문서화한 컬렉션을 보여줍니다.
