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 ファイル

方向

モデルカードを完全に記入するには、いくつかの異なる役割からの入力が必要です。（1人が複数の役割を担う場合もあります。）ここでは、これらの役割を、コードの作成とトレーニングの実行を行う開発者、技術と社会の長期的な相互作用の分析に長けた社会技術者（弁護士、倫理学者、社会学者、権利擁護活動家などが含まれます）、そしてモデルの全体的な範囲と影響度を理解し、カードの各部分を概ね記入でき、モデルカードの更新に関する連絡窓口となるプロジェクトコーディネーターと呼びます。

手順は以下に斜体で示されています。

テンプレートの変数名はmonospaceで表示されます。

モデル名

セクション概要: モデル名と、そのモデルが何であるかを1〜2文で要約してください。

model_id

model_summary

目次

セクション概要: 各セクションへのリンクを付与し、目次を保持したまま他の場所でファイルを参照・印刷したり、内容を容易にジャンプできるようにします。

モデルの詳細

セクション概要: このセクションでは、モデルの概要、現在のステータス、および出典に関する基本的な情報を提供します。モデルを参照したい方にとって有用な情報です。

モデルの説明

model_description

モデルに関する基本的な詳細を記載します。これには、アーキテクチャ、バージョン、論文で発表されたかどうか、元の実装が利用可能かどうか、作成者が含まれます。著作権もここで帰属させます。トレーニング手順、パラメータ、重要な免責事項に関する一般的な情報も、このセクションで言及できます。

  • 開発者: developers

モデルを構築した人々を（理想적으로는リンクを付けて）リストアップしてください。

  • 資金提供: funded_by

このモデルを資金面、計算資源面、その他で支援または実現した資金提供元をリスト化し（理想적으로는リンクを付与し）てください。

  • 共有者（任意）: shared_by

モデルをオンラインで公開している人または組織を（理想としてはリンクを付けて）リストアップしてください。

  • モデルタイプ: model_type

「type」には以下のように名前を付けることができます：

1. 教師あり学習/学習手法

2. 機械学習の種類

3. モダリティ

  • 言語 [NLP]: language

システムが自然言語（人間の言語）を使用または処理する場合に、このフィールドを使用します。

  • ライセンス: license

使用しているライセンスの名前とリンク。

  • ファインチューニング元のモデル [オプション]: base_model

このモデルが別のモデルをベースにしている場合、そのモデルへのリンクをここに記載してください。

モデルソース（任意）

  • リポジトリ: repo
  • 論文 [任意]: paper
  • デモ [任意]: demo

ユーザーがモデルとその詳細を直接確認できるように、ソースを提供してください。追加のリソースの種類（トレーニングログ、得られた教訓など）は、More Informationセクションに属します。このセクションに1つだけ含める場合は、リポジトリへのリンクを貼ってください。

用途

セクション概要: このセクションでは、モデルが異なる応用文脈でどのように使用されることを意図しているかに関する質問に答え、モデルの予見可能なユーザー（モデルの影響を受ける者を含む）について議論し、モデルの範囲外とみなされる使用や誤用を説明します。なお、このセクションにはライセンスの使用詳細を含めることを意図していません。その詳細については、ライセンスに直接リンクしてください。

直接利用

direct_use

ファインチューニング、後処理、パイプラインへの組み込みなしでモデルを使用する方法を説明してください。コードスニペットの例を推奨します。

Downstream Use は任意

downstream_use

このモデルがタスク向けにファインチューニングされた場合、またはより大きなエコシステムやアプリに組み込まれた場合にどのように使用できるかを説明してください。コードスニペットの例を推奨します。

範囲外の使用

out_of_scope_use

モデルが予見可能な形で誤用される（意図した用途で機能しない形で使用される）可能性のあるケースを列挙し、ユーザーがモデルに対して行ってはならないことを明確にしてください。

バイアス、リスク、および制約

セクション概要: このセクションでは、予見可能な害、誤解、および技術的・社会技術的な制約を特定します。また、警告や潜在的な緩和策に関する情報も提供します。バイアス、リスク、制約は、場合によっては区別がつかない、あるいは同じ問題に言及していることがあります。一般的に、バイアスとリスクは社会技術的なものであり、制約は技術的なものです:

  • biasとは、特定のサブグループに対するステレオタイプや、偏ったパフォーマンス（skew）を指します。
  • リスクとは、モデルが引き起こす可能性のある社会的に関連する問題です。
  • 制約とは、列挙された推奨事項に従って対処できる可能性のある失敗モードです。

bias_risks_limitations

このモデルに起因する既知または予見可能な問題は何ですか？

推奨事項

bias_recommendations

予見可能な問題に関する推奨事項は何か？「画像をダウンサンプルする」から「露骨なコンテンツのフィルタリング」まで、あらゆる内容を含み得る。

トレーニングの詳細

セクション概要: このセクションでは、トレーニングの記述と再現に必要な情報、すなわちトレーニングデータ、トレーニング要素の速度とサイズ、およびトレーニングの環境への影響について提供します。これは 技術仕様 とも密接に関連しており、トレーニング手順に関連する場合は、そのセクションへのリンクを貼る必要があります。モデルの入力やトレーニングのフットプリントについて詳しく知りたい方にとって有用です。 モデルが何を学習しているのかという基本を知りたい方にも関連します。

学習データ

training_data

学習データの内容を1〜2文で記述してください。理想적으로는、詳細な情報についてはDataset Cardへのリンクを貼ることです。データの前処理や追加のフィルタリングに関連するドキュメントへのリンクも、こことMore Informationの両方に記載できます。

トレーニング手順（オプション）

前処理

preprocessing

トークン化の詳細、リサイズ/書き換え（モダリティによって異なる）、など

速度、サイズ、時間

speeds_sizes_times

スループットの詳細、開始/終了時刻、チェックポイントのサイズなどを記録します。

評価

Section Overview: This section describes the evaluation protocols, what is being measured in the evaluation, and provides the results. Evaluation ideally has at least two parts, with one part looking at quantitative measurement of general performance (Testing Data, Factors & Metrics), such as may be done with benchmarking; and another looking at performance with respect to specific social safety issues (Societal Impact Assessment), such as may be done with red-teaming. You can also specify your model’s evaluation results in a structured way in the model card metadata. Results are parsed by the Hub and displayed in a widget on the model page. See https://huggingface.co/docs/hub/model-cards#evaluation-results.

テストデータ、ファクターおよびメトリクス

評価は、タスク、ドメイン、人口のサブグループなどの異なる要因に対して、理想的には分解して行い、想定される使用文脈において最も意味のある指標を用いて計算されるべきです。異なるサブグループ間で評価性能が等しい場合、それらのサブグループ間で「公平」であると言われます。目標となる公平性指標は、モデルの使用を踏まえて、どのエラーがより問題を引き起こす可能性が高いかに基づいて決定されるべきです。ただし、このセクションは、異なるタスクベンチマークにおける集計された評価性能を報告するために最もよく使用されます。

テストデータ

testing_data

テストデータの説明、またはその Dataset Card へのリンクを記載してください。

要因

testing_factors

モデルの動作に影響を与えると考えられる特性は何か？パフォーマンスの偏りを明らかにするため、これらの要因ごとに評価を分解して行うのが望ましい。

メトリクス

testing_metrics

評価にはどのメトリクスが使用されますか？

結果

results

結果は、上記で定義されたファクターとメトリクスに基づいて作成する必要があります。

概要

results_summary

結果は何を伝えているのでしょうか？これは一般の読者向けの要約（tl;dr）として機能します。

社会的影響評価は任意です

この自由記述欄を使用して、このモデルが社会的危害のリスク（児童の安全、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_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

←よくある質問 モデルカードガイドブック→