Hugging Face's logo

Hub documentation

주석 달린 모델 카드 템플릿

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

주석 달린 모델 카드 템플릿

발행을 준비 중이신가요? 간결하고 정보량이 풍부하며 사용자 친화적인 모델 릴리스를 위한 필수 단계를 확인하려면 Model Release Checklist를 참고하세요.

템플릿

modelcard_template.md 파일

방향

모델 카드를 완전히 작성하려면 몇 가지 다른 역할의 입력이 필요합니다. (한 사람이 여러 역할을 맡을 수 있습니다.) 이러한 역할을 개발자(코드를 작성하고 학습을 실행하는 사람), 사회기술 전문가(기술과 사회의 장기적 상호작용을 분석하는 데 숙련된 사람. 여기에는 변호사, 윤리학자, 사회학자, 권리 옹호자가 포함됨), 그리고 프로젝트 조직자(모델의 전체 범위와 영향력을 이해하고 카드의 각 부분을 대략적으로 작성할 수 있으며 모델 카드 업데이트에 대한 연락 창구 역할을 하는 사람)라고 부릅니다.

지시사항은 아래에 이탤릭체로 제공됩니다.

템플릿 변수 이름은 monospace로 표시됩니다.

모델 이름

섹션 개요: 모델 이름과 모델에 대한 1~2문장의 요약을 제공합니다.

model_id

model_summary

목차

섹션 개요: 각 섹션으로 연결되는 링크를 제공하여 사용자가 쉽게 이동하거나, TOC를 유지한 채 다른 위치에 파일을 사용하거나, 내용을 인쇄하는 등의 작업을 수행할 수 있도록 합니다.

모델 세부 정보

섹션 개요: 이 섹션은 모델이 무엇인지, 현재 상태, 그리고 출처에 대한 기본 정보를 제공합니다. 모델을 참조하려는 모든 사람에게 유용합니다.

모델 설명

model_description

모델에 대한 기본 정보를 제공합니다. 여기에는 아키텍처, 버전, 논문에서 소개되었는지 여부, 원본 구현이 있는지 여부, 제작자가 포함됩니다. 저작권도 여기에 명시해야 합니다. 학습 절차, 매개변수, 중요한 면책 조항에 대한 일반적인 정보도 이 섹션에서 언급할 수 있습니다.

  • 개발자: developers

모델을 구축한 사람들을 나열하고(이상적으로는 링크를 포함하여) 명시하세요.

  • 후원: funded_by

이 모델을 재정적, 계산적 또는 기타 방식으로 지원하거나 가능하게 한 자금 출처를 나열하고(이상적으로는 링크를 포함하여) 제시하세요.

  • 공유자 [선택 사항]: shared_by

모델을 온라인으로 제공하는 사람/조직을 나열하고(이상적으로는 링크를 포함하고) 설명합니다.

  • 모델 유형: model_type

“type”을 다음과 같이 지정할 수 있습니다:

1. 감독/학습 방법

2. 기계 학습 유형

3. 모달리티

  • 언어 [NLP]: language

시스템이 자연(인간) 언어를 사용하거나 처리할 때 이 필드를 사용하세요.

  • 라이선스: license

사용 중인 라이선스의 이름과 링크.

  • 파인튜닝된 모델 [선택 사항]: base_model

이 모델의 기반이 되는 다른 모델이 있다면, 해당 모델에 대한 링크를 여기에 추가하세요.

모델 소스 선택

  • 저장소: repo
  • 논문 [선택 사항]: paper
  • 데모 [선택 사항]: demo

모델과 그 세부 사항을 사용자가 직접 확인할 수 있도록 출처를 제공하세요. 학습 로그, 교훈 등 추가적인 리소스는 More Information 섹션에 포함해야 합니다. 이 섹션에 하나만 포함한다면 저장소 링크를 포함하세요.

사용

섹션 개요: 이 섹션은 모델이 다양한 적용 맥락에서 어떻게 사용될 것으로 의도되는지에 대한 질문을 다루고, 모델의 예상 사용자(모델에 영향을 받는 사람을 포함)를 논의하며, 모델의 범위 밖 사용 또는 오용으로 간주되는 용도를 설명합니다. 이 섹션에는 라이선스 사용 세부 사항이 포함되지 않도록 의도되었습니다. 해당 내용은 라이선스에 직접 링크를 걸어 참조하세요.

직접 사용

direct_use

모델을 파인튜닝, 후처리 또는 파이프라인 연결 없이 사용할 수 있는 방법을 설명하세요. 예제 코드 스니펫을 권장합니다.

다운스트림 사용 선택 사항

downstream_use

이 모델이 특정 작업으로 fine-tuning되었거나 더 큰 생태계나 앱에 통합되었을 때 어떻게 사용될 수 있는지 설명합니다. 예제 코드 스니펫을 권장합니다.

범위 외 사용

out_of_scope_use

모델이 예측 가능하게 오용될 수 있는 방법(모델이 의도된 용도로 작동하지 않는 방식으로 사용되는 경우)을 나열하고, 사용자가 모델에 대해 하지 말아야 할 사항을 명시합니다.

편향, 위험 및 한계

섹션 개요: 이 섹션에서는 예측 가능한 해악, 오해, 기술적 및 사회기술적 한계를 식별합니다. 또한 경고 및 잠재적 완화 조치에 대한 정보를 제공합니다. 편향, 위험, 한계는 때때로 분리할 수 없거나 동일한 문제를 가리킬 수 있습니다. 일반적으로 편향과 위험은 사회기술적이며, 한계는 기술적입니다:

  • bias는 특정 하위 집단에 대한 고정관념 또는 불균형한 성능(편향)을 의미합니다.
  • 리스크란 모델이 유발할 수 있는 사회적 관련성이 있는 문제를 의미합니다.
  • 한계는 나열된 권장 사항을 따름으로써 해결할 수 있는 잠재적 실패 모드입니다.

bias_risks_limitations

이 모델에서 발생하거나 발생할 수 있는 알려진 또는 예측 가능한 문제는 무엇인가요?

권장 사항

bias_recommendations

예상되는 문제에 대한 권장 사항은 무엇인가요? 여기에는 “이미지를 다운샘플링한다”부터 노골적인 콘텐츠 필터링까지 모든 것이 포함될 수 있습니다.

학습 세부 정보

섹션 개요: 이 섹션은 학습을 설명하고 재현하는 데 필요한 정보를 제공합니다. 여기에는 학습 데이터, 학습 요소의 속도와 크기, 학습의 환경적 영향이 포함됩니다. 이 내용은 기술 사양과도 밀접하게 관련되어 있으며, 학습 절차와 관련이 있는 경우 해당 섹션으로 링크를 걸어야 합니다. 모델 입력과 학습 규모에 대해 더 알고 싶은 사람들에게 유용합니다. 모델이 무엇을 학습하는지에 대한 기본 사항을 알고 싶은 모든 사람에게 관련이 있습니다.

학습 데이터

training_data

학습 데이터가 무엇인지 1~2문장으로 설명합니다. 이상적으로는 추가 정보를 위해 Dataset Card로 연결됩니다. 데이터 전처리 또는 추가 필터링과 관련된 문서 링크도 여기에 포함할 수 있으며, 추가 정보에도 포함할 수 있습니다.

Training Procedure 선택 사항

전처리

preprocessing

토큰화, 리사이즈/재작성(모달리티에 따라), 기타 세부 사항

속도, 크기, 시간

speeds_sizes_times

처리량, 시작/종료 시간, 체크포인트 크기 등을 자세히 기록합니다.

평가

섹션 개요: 이 섹션에서는 평가 프로토콜, 평가에서 측정되는 항목, 그리고 결과를 설명합니다. 이상적인 평가는 두 부분으로 구성되며, 하나는 벤치마킹과 같이 일반 성능의 정량적 측정을 살펴보는 부분(테스트 데이터, 요인 및 지표)이고, 다른 하나는 레드팀과 같이 특정 사회적 안전 이슈에 대한 성능을 살펴보는 부분(사회적 영향 평가)입니다. 또한 모델 카드 메타데이터에 구조화된 방식으로 모델의 평가 결과를 지정할 수도 있습니다. 결과는 Hub에서 파싱되어 모델 페이지의 위젯에 표시됩니다. https://huggingface.co/docs/hub/model-cards#evaluation-results를 참조하세요.

테스트 데이터, 요인 및 지표

평가의 이상적인 형태는 작업, 도메인, 인구 하위 집단과 같은 다양한 요인에 대해 분리(disaggregated)하여 수행하는 것이며, 예상되는 사용 맥락에서 가장 의미 있는 지표로 계산하는 것입니다. 서로 다른 하위 집단 간에 평가 성능이 동등한 경우, 해당 하위 집단에 대해 “공정(fair)”하다고 표현합니다. 목표 공정성 지표는 모델 사용 맥락에서 어떤 오류가 더 문제될 가능성이 높은지에 근거하여 결정해야 합니다. 그러나 이 섹션은 일반적으로 다양한 작업 벤치마크에 대한 집계된 평가 성능을 보고하는 데 가장 많이 사용됩니다.

테스트 데이터

testing_data

테스트 데이터를 설명하거나 해당 Dataset Card 링크를 제공하세요.

요인

testing_factors

모델의 동작에 영향을 미칠 것으로 예상되는 특성은 무엇입니까? 성능의 격차를 파악하기 위해 이상적으로는 이러한 요소를 기준으로 평가가 세분화되어야 합니다.

Metrics

testing_metrics

평가에 어떤 지표가 사용될까요?

결과

results

결과는 위에서 정의한 요인(Factors)과 지표(Metrics)를 기반으로 해야 합니다.

요약

results_summary

결과는 무엇을 말해줍니까? 이는 일반 독자를 위한 일종의 요약으로 기능할 수 있습니다.

사회적 영향 평가 선택 사항

이 무료 텍스트 섹션을 사용하여 아동 안전, NCII, 개인정보, 폭력 등 사회적 해악 위험에 대해 이 모델이 어떻게 평가되었는지 설명하십시오. 이는 다음 질문에 대한 답변의 형태를 취할 수 있습니다:

  • 이 모델은 어린이가 사용해도 안전한가요? 그 이유는 무엇인가요?
  • 비동의 친밀 이미지(포함 CSEM)와 관련된 위험을 평가하기 위해 이 모델이 테스트되었습니까?
  • 폭력적 활동 또는 폭력의 묘사와 관련된 위험을 평가하기 위해 이 모델이 테스트되었습니까? 결과는 무엇이었습니까?

각 이슈에 대한 정량적 수치도 제공될 수 있습니다.

모델 검사 선택 사항

섹션 개요: 일부 개발자가 추가하기 시작한 실험적 섹션으로, 설명 가능성/해석 가능성에 대한 작업이 여기에 포함될 수 있습니다.

model_examination

환경적 영향

섹션 개요: 전기 사용량 및 탄소 배출량과 같은 환경적 영향을 계산하는 데 필요한 정보를 요약합니다.

  • 하드웨어 유형: hardware_type
  • 사용 시간: hours_used
  • 클라우드 제공업체: cloud_provider
  • 컴퓨팅 리전: cloud_region
  • 배출된 탄소: co2_emitted

탄소 배출량은 Lacoste et al. (2019)에서 제시한 Machine Learning Impact calculator를 사용하여 추정할 수 있습니다.

기술 사양 선택

섹션 개요: 이 섹션에는 모델의 목적과 아키텍처, 그리고 컴퓨트 인프라에 대한 세부 정보가 포함되어 있습니다. 모델 개발에 관심이 있는 분들에게 유용합니다. 이 섹션을 작성하려면 일반적으로 모델 개발자가 직접 관여해야 합니다.

모델 아키텍처 및 목표

model_specs

컴퓨트 인프라

compute_infrastructure

하드웨어

hardware_requirements

최소 하드웨어 요구 사항, 예: 처리, 저장, 메모리 요구 사항은 무엇인가요?

소프트웨어

software

인용은 선택 사항

섹션 개요: 이 모델에 대한 개발자가 선호하는 인용 정보입니다. 보통 논문입니다.

BibTeX

citation_bibtex

APA

citation_apa

용어집 선택

섹션 개요: 이 섹션에서는 공통 용어와 지표 계산 방식을 정의합니다.

glossary

다양한 독자를 위해 용어를 명확하게 정의합니다.

추가 정보 선택

섹션 개요: 이 섹션에서는 데이터셋 생성, 기술 사양, 교훈, 초기 결과에 대한 글을 링크로 제공합니다.

more_information

Model Card 저자 선택

섹션 개요: 이 섹션은 모델 카드를 작성한 사람들을 나열하여, 모델 카드 제작에 투입된 상세한 작업에 대한 공로 인정과 책임을 부여합니다.

model_card_authors

모델 카드 연락처

섹션 개요: Model Card 업데이트, 제안, 질문이 있는 사람이 Model Card 작성자에게 연락할 수 있는 방법을 제공합니다

model_card_contact

모델 시작하기

섹션 개요: 모델을 사용하는 방법을 보여주는 코드 스니펫을 제공합니다.

get_started_code

인용 방법: Ozoani, Ezi and Gerchick, Marissa and Mitchell, Margaret. Model Card Guidebook. Hugging Face, 2022. https://huggingface.co/docs/hub/en/model-card-guidebook

Update on GitHub

←자주 묻는 질문 Model Card 가이드북→