Hub documentation

モデルリリースチェックリスト

Hub

API docs

Join the Hugging Face community

and get access to the augmented documentation experience

Collaborate on models, datasets and Spaces

Faster examples with accelerated inference

Switch between documentation themes

to get started

モデルリリースチェックリスト

Hugging Face Hubは、機械学習モデルの共有のための定番プラットフォームです。適切に行われたリリースは、モデルの認知度とインパクトを高めることができます。このセクションでは、簡潔で情報量があり、ユーザーフレンドリーなモデルリリースのための必須の手順について説明します。

コーディングエージェントでリリースしますか？hf CLI Skill をインストールして、アップロード、モデルカード、メタデータの処理をエージェントに代行させましょう。

⏳ モデルの公開に向けた準備

モデルの重みをアップロードする

Hubにモデルをアップロードする際は、以下のベストプラクティスに従ってください。

異なるモデルの重みには別々のリポジトリを使用する: 同じアーキテクチャの各バリアントに対して個別のリポジトリを作成します。これにより、コレクションとしてグループ化でき、ディレクトリ一覧よりもナビゲーションが容易になります。また、各モデルに固有のURL（hf.co/org/model-name）が割り当てられるため、視認性が向上し、検索が容易になり、各モデルのダウンロード数が提供されます。優れた例として、VLアーキテクチャのさまざまなバリアントを収録した最近のQwen3-VLコレクションがあります。
safetensorsをpickleより優先して重みのシリアライズに使用してください。: safetensorsはPythonのpickleやpthよりも安全で高速です。.binのpickleファイルがある場合は、重み変換ツールを使用して変換してください。

包括的なモデルカードの作成

適切に作成されたモデルカード（リポジトリ内のREADME.md）は、発見可能性、再現性、効果的な共有のために不可欠です。以下の点について記載してください。

メタデータ設定: モデルカードの上部にあるメタデータセクション(YAML)は、検索と分類において重要です。以下を含めてください:

---
pipeline_tag: text-generation    # Specify the task
library_name: transformers       # Specify the library
language:
  - en                           # List languages your model supports
license: apache-2.0              # Specify a license
datasets:
  - username/dataset             # List datasets used for training
base_model: username/base-model  # If applicable (your model is a fine-tune, quantized, merged version of another model)
tags:                            # Add extra tags which would make the repo searchable using the tag
  - tag1 
  - tag2
---

Web UI で README.md を作成すると、推奨する最も重要なメタデータフィールドを含むフォームが表示されます 🤗。


Hub UIのメタデータフォーム

モデルの詳細な説明: モデルの機能、アーキテクチャ、想定されるユースケースについて明確に説明してください。ユーザーが自分のニーズに合致するかを素早く判断できるように支援します。
使用例: 推論、ファインチューニング、その他の一般的なタスクに対して、明確でそのままコピーして実行できるコードスニペットを提供します。ユーザーが加える必要がある編集は最小限に抑えてください。

ボーナス: 推論またはファインチューニングを示す、構成の整ったnotebook.ipynbをリポジトリに追加し、ユーザーがGoogle ColabやKaggle Notebooksで直接開けるようにします。

Google と Kaggle の使用ボタン
技術仕様: モデルを効果的に実行するために役立つ、学習パラメータ、ハードウェア要件、その他の詳細を含めてください。
パフォーマンス指標: ベンチマークおよび評価結果を共有してください。強みと限界を示すために、定量的な指標と定性的な例を含めてください。
制約とバイアス: ユーザーが情報に基づいた選択を行えるよう、既知の制約、バイアス、倫理的な考慮事項を文書化してください。


Google と Kaggle の使用ボタン

プロセスをよりシームレスにするために、Import model card template をクリックして、プレースホルダー付きの README.md を事前入力してください。


モデルカードテンプレートをインポートするためのボタン	インポートされたテンプレートのセクション

モデルの発見性と使いやす性の向上

リーチと使いやすさを最大化するために:

ライブラリ統合: Hugging Face Hub と統合されている多くのライブラリ（transformers、diffusers、sentence-transformers、timm など）のいずれかに対するサポートを追加します。この統合により、モデルのアクセシビリティが大幅に向上し、ユーザーにはモデルを扱うためのコードスニペットが提供されます。

例えば、モデルがtransformersライブラリで動作することを指定するには:
```
---
library_name: transformers
---
```
コードスニペットタブ

また、独自のモデルライブラリを登録したり、ライブラリやコードベースに Hub のサポートを追加したりすることで、ユーザーが Hub からモデルの重みをダウンロードする方法を知ることができます。

アップロードのベストプラクティスに関する詳細なガイドをこちらに作成しました。

登録済みライブラリを使用することで、モデルのダウンロード数を時間経過とともに追跡することもできます。
メタデータの修正:
- パイプラインタグ: モデルが適切な検索結果やウィジェットに表示されるよう、正しいパイプラインタグを選択してください。
一般的なパイプラインタグの例:
- text-generation - テキストを生成する言語モデル向け
- text-to-image - テキストから画像を生成するモデル向け
- image-text-to-text - テキストを生成するビジョン・言語モデル（VLM）向け
- text-to-speech - テキストからオーディオを生成するモデル向け
- ライセンス: ライセンス情報は、モデルの利用方法を理解するためにユーザーにとって重要です。
研究論文: モデルに関連する論文がある場合は、モデルカードに引用してください。それらは自動的に相互リンクされます。
```
## References

* [Model Paper](https://arxiv.org/abs/xxxx.xxxxx)
```
コレクション: 関連する複数のモデルやバリアントをリリースする場合は、コレクションにまとめて整理してください。コレクションを使用すると、ユーザーは関連するモデルを見つけやすく、バージョン間の関係性を理解しやすくなります。
デモ: インタラクティブなデモを含むHugging Face Spaceを作成します。これにより、ユーザーはコードを書かずにモデルを試すことができます。また、Spaceからモデルへのリンクを設定することで、モデルページのUIに表示させることもできます。
```
## Demo

Try this model directly in your browser: [Space Demo](https://huggingface.co/spaces/username/model-demo)
```
デモを作成する際は、モデルを外部ソース（Google Drive など）ではなく、その Hub リポジトリからダウンロードしてください。これにより成果物が相互にリンクされ、視認性が向上します。
量子化バージョン: 計算リソースが限られているユーザーのアクセシビリティを向上させるため、量子化バージョン（GGUF など）を別のリポジトリにアップロードすることを検討してください。量子化モデルカード上で、base_modelメタデータフィールドを使用してこれらのバージョンをリンクし、パフォーマンスの違いを文書化してください。
```
---
base_model: username/original-model
base_model_relation: quantized
---
```
量子化バージョンを示すモデルツリー
モデルページへのデータセットのリンク: メタデータにデータセットをリンクすることで、モデルページに直接表示されるようになります。
```
---
datasets:
- username/dataset
- username/dataset-2
---
```
新しいモデルのバージョン: モデルが既存のモデルの更新版である場合は、古いモデルのカードにその旨を指定してください。これにより、古いページに更新先へのリンクを含むバナーが表示されます。
```
---
new_version: username/updated-model
---
```
ビジュアルの例: 画像や動画の生成モデルでは、<Gallery>カードコンポーネントを使用して、モデルのページに直接例を含めてください。
```
<Gallery>
![Example 1](./images/example1.png)
![Example 2](./images/example2.png)
</Gallery>
```


コードスニペットタブ


量子化バージョンを示すモデルツリー

炭素排出量: 可能であれば、学習に伴う炭素排出量を指定してください。

---
co2_eq_emissions:
  emissions: 123.45
  source: "CodeCarbon"
  training_type: "pre-training"
  geographical_location: "US-East"
  hardware_used: "8xA100 GPUs"
---

アクセス制御と可視性

表示設定: モデルを共有する準備ができた時点で、モデル設定で公開に切り替えてください。その前に、すべてのドキュメントとコード例が正確かつ完全であることを再確認してください。
ゲート付きアクセス: モデルにアクセス制御が必要な場合は、ゲート付きアクセス機能を使用し、ユーザーが満たすべき条件を明確に示してください。これは、二重利用の懸念があるモデルや、商用制限があるモデルにとって重要です。

🏁 モデルのリリース後

モデルの公開が成功するには、最初のリリース以降の継続的な取り組みが不可欠です。品質を維持し、インパクトを最大化するために:

メンテナンスとコミュニティへの関与

機能の検証: リリース後、クリーンな環境ですべてのコードスニペットをテストし、期待通りに動作することを確認します。これにより、ユーザーがエラーや混乱なくモデルを実行できることを保証します。

例えば、モデルがtransformers互換のLLMである場合:
```
from transformers import pipeline

# This should run without errors
pipe = pipeline("text-generation", model="your-username/your-model")
result = pipe("Your test prompt")
print(result)
```
共有共有共有: ほとんどのユーザーは、ソーシャルメディア、チャットチャンネル（Slack や Discord など）、ニュースレターを通じてモデルを発見します。これらの場でモデルのリンクを共有するとともに、ウェブサイトや GitHub リポジトリにも追加してください。

モデルへのアクセス数や「いいね」の数が多くなるほど、Hugging Face Trending sectionでの表示順位が上がり、さらなる注目を集めることができます。
コミュニティとの交流: Community タブを使用して、質問への回答、フィードバックへの対応、問題の迅速な解決を行いましょう。混乱を解消し、有益な提案を受け入れ、オフトピックのスレッドを閉じることで、議論が焦点を絞った状態を維持します。

評価結果を追加

Hubでサポートされているベンチマークデータセットのいずれかで評価を実行した場合、モデルリポジトリに評価結果を追加できます。これにより、モデルページおよびデータセットリポジトリのベンチマークリーダーボード上で、ベンチマークスコアが直接表示されるようになります。完全な仕様については、Evaluation Resultsのドキュメントを参照してください。

評価結果を追加するには、モデルリポジトリの.eval_results/フォルダにYAMLファイルを作成します。各ファイルはHub Benchmarkのデータセットを参照します。

# .eval_results/gpqa.yaml
- dataset:
    id: Idavidrein/gpqa
    task_id: diamond
  value: 76.1
  date: "2026-03-19"
  source:
    url: https://huggingface.co/your-org/your-model
    name: Model Card
    user: your-username

task_idは、ベンチマークデータセットのeval.yamlで定義されているタスクと一致する必要があります。HLEなどのベンチマークデータセットのリポジトリにあるeval.yamlファイルを確認することで、利用可能なベンチマークとそのタスクIDを見つけることができます。

コミュニティの誰でも、Pull Request を作成することで、任意のモデルに評価結果を提出できます。コミュニティから提出されたスコアは、モデルページに「community」バッジが表示されます。このプロセスを円滑にするために、community-evals リポジトリを使用できます。このリポジトリには、モデルカードからスコアを抽出し、PR を自動的に作成するためのスクリプトとエージェントスキルが提供されています。

利用状況と影響の追跡

使用状況メトリクス: ダウンロード数と「いいね」数を追跡して、モデルのリーチと採用状況を把握できます。モデルの設定画面で、ダウンロード総数のメトリクスを確認できます。
コミュニティの貢献を確認する: 定期的に、他のユーザーからの貢献がないかモデルのリポジトリを確認してください。コミュニティからのプルリクエストやディスカッションは、有用なフィードバック、アイデア、そしてコラボレーションの機会をもたらす可能性があります。

🏢 エンタープライズ機能

Hugging Face Team & Enterprise サブスクリプションは、チームや組織向けの追加の機能を提供します：

アクセス制御: リソースグループを設定して、特定のチームやユーザーへのアクセスを管理します。これにより、組織全体で適切な権限と安全なコラボレーションが確保されます。
ストレージリージョン: モデルファイルのデータ保存リージョン（USまたはEU）を選択し、地域別のデータ規制およびコンプライアンス要件を満たします。
高度な分析: Publisher Analytics を使用して、組織全体でのモデルの使用方法、ダウンロード数、採用傾向に関する詳細なインサイトを得ます。
拡張ストレージ: モデルポートフォリオの拡大に伴い、より多くのモデルや大きな成果物をホストするために、追加のプライベートストレージ容量にアクセスできます。
組織のブログ記事: エンタープライズ組織は、Hugging Face に直接ブログ記事を公開できるようになりました。これにより、モデルのリリース、研究のアップデート、アナウンスを、組織のプロファイルからより広いコミュニティと共有できます。

これらのガイドラインと例に従うことで、Hugging Face でのモデルリリースを明確で有用かつ影響力のあるものにできます。これにより、あなたの成果がより多くの人々に届き、AI コミュニティが強化され、モデルの認知度も高まります。

次に何を共有されるのか、今からとても楽しみです！🤗

Update on GitHub

←モデルのダウンロード統計ハードウェア→