> ## 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.

# 컬렉션에 주석 추가하기

> 레지스트리 컬렉션에 설명과 문서를 추가하여 사용자가 컬렉션의 목적과 내용을 쉽게 파악할 수 있도록 하세요.

컬렉션에 이해하기 쉬운 텍스트를 추가하면 사용자가 컬렉션의 목적과 컬렉션에 포함된 아티팩트를 쉽게 파악할 수 있습니다.

<Frame>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/coreweave-dbfa0e8d/products/registry/_media/registry_card.gif" alt="컬렉션 Card" />
</Frame>

컬렉션에 따라 트레이닝 데이터, 모델 아키텍처, 작업, 라이선스, 레퍼런스, 배포에 관한 정보를 포함할 수 있습니다. 다음은 컬렉션에 문서화해 두면 좋은 주제입니다.

W\&B는 최소한 다음 정보를 포함할 것을 권장합니다.

* **요약**: 컬렉션의 목적과 머신러닝 실험에 사용된 머신러닝 프레임워크.
* **라이선스**: 머신러닝 모델 사용과 연결된 법적 조건 및 권한. 모델 사용자가 어떤 법적 틀 안에서 모델을 활용할 수 있는지 파악하는 데 도움이 됩니다. 대표적인 라이선스로는 Apache 2.0, MIT, GPL 등이 있습니다.
* **레퍼런스**: 관련 연구 논문, 데이터셋 또는 외부 리소스에 대한 인용이나 참고 자료.

컬렉션에 트레이닝 데이터가 포함된 경우 다음 정보도 함께 포함하는 것이 좋습니다.

* **트레이닝 데이터**: 사용된 트레이닝 데이터에 대한 설명
* **처리**: 트레이닝 데이터셋에 적용한 처리 과정.
* **데이터 저장소**: 데이터가 저장된 위치와 액세스 방법.

컬렉션에 머신러닝 모델이 포함된 경우 다음 정보도 함께 포함하는 것이 좋습니다.

* **아키텍처**: 모델 아키텍처, 레이어 및 주요 설계 결정에 관한 정보.
* **작업**: 컬렉션의 모델이 수행하도록 설계된 구체적인 작업 또는 문제 유형. 모델이 의도한 기능을 분류한 것입니다.
* **모델 역직렬화**: 팀원이 모델을 메모리에 로드하는 방법을 안내하세요.
* **배포**: 모델이 배포되는 방식과 위치에 관한 세부 정보, 그리고 워크플로 오케스트레이션 플랫폼 등 다른 엔터프라이즈 시스템에 모델을 통합하는 방법에 관한 안내.
* **메트릭 비교**: 컬렉션에 연결된 아티팩트의 여러 버전 간에 메트릭을 비교합니다. 이를 통해 사용자는 모델이 시간에 따라 어떻게 발전해 왔는지, 각 버전이 특정 작업에서 어떤 성능을 내는지 파악할 수 있습니다.

<h2 id="add-a-description-to-a-collection">
  컬렉션에 설명 추가하기
</h2>

레지스트리 UI에서 대화형으로 추가하거나 Python SDK를 사용하여 프로그래밍 방식으로 컬렉션에 설명을 추가할 수 있습니다.

<Tabs>
  <Tab title="Registry UI">
    1. [https://forge.coreweave.com/registry/](https://forge.coreweave.com/registry/) 에서 레지스트리로 이동하세요.
    2. 컬렉션을 클릭하세요.
    3. 컬렉션 이름 옆에 있는 **View details**를 선택하세요.
    4. **컬렉션 Card** 탭을 선택하세요.
    5. **Edit card** 버튼을 클릭하세요.
    6. 컬렉션 Card 편집기에서 컬렉션에 설명을 추가하세요. Markdown 서식으로 텍스트 스타일을 지정할 수 있습니다.

    <Tip>
      [Markdown 마크업 언어](https://www.markdownguide.org/)로 텍스트 서식을 지정하세요. 슬래시(`/`)를 입력하면 사용 가능한 Markdown 서식 옵션이 드롭다운 목록으로 표시됩니다.
    </Tip>
  </Tab>

  <Tab title="W&B Python SDK">
    [`wandb.Api().artifact_collection()`](/ko/products/wandb/ref/python/public-api/api#method-api-artifact_collection) 메서드를 사용하여 컬렉션의 설명에 액세스하세요. 반환된 객체의 `description` 속성으로 컬렉션의 설명을 추가하거나 업데이트할 수 있습니다.

    `type_name` 매개변수에는 컬렉션의 유형을, `name` 매개변수에는 컬렉션의 전체 이름을 지정하세요. 컬렉션 이름은 접두사 "wandb-registry", 레지스트리 이름, 컬렉션 이름을 슬래시로 구분한 형식입니다.

    ```text theme={"system"}
    wandb-registry-{REGISTRY_NAME}/{COLLECTION_NAME}
    ```

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

    ```python theme={"system"}
    import wandb

    api = wandb.Api()

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


    collection.description = "This is a description."
    collection.save()  
    ```
  </Tab>
</Tabs>

<h2 id="compare-metrics-across-artifact-versions">
  아티팩트 버전 간 메트릭 비교
</h2>

컬렉션 Card 편집기에서는 컬렉션에 연결된 여러 아티팩트 버전의 메트릭을 비교할 수 있습니다.

1. 컬렉션 Card 편집기에서 슬래시(`/`)를 입력하면 사용 가능한 Markdown 서식 옵션의 드롭다운 목록이 열립니다.
2. **Compare metrics**를 선택하여 컬렉션 Card에 메트릭 비교 table을 추가하세요.

다음 이미지는 `transaction-risk-model` 컬렉션에 연결된 아티팩트 버전 5개의 `val/loss`를 비교한 모습입니다.

<Frame>
  <img src="https://mintcdn.com/coreweave-dbfa0e8d/3Dv_sw2eg8feUJlx/products/registry/_media/compare_linked_artifact_versions.png?fit=max&auto=format&n=3Dv_sw2eg8feUJlx&q=85&s=33ef9463bbe48b980db5b5b9255af00b" alt="컬렉션 카드에서 버전별 아티팩트 메트릭 비교 및 확인" width="2780" height="1764" data-path="products/registry/_media/compare_linked_artifact_versions.png" />
</Frame>
