Hub documentation

Daftar Periksa Rilis Model

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Daftar Periksa Rilis Model

Hugging Face Hub adalah platform utama untuk berbagi model machine learning. Rilis yang dieksekusi dengan baik dapat meningkatkan visibilitas dan dampak model Anda. Bagian ini membahas langkah-langkah esensial untuk rilis model yang ringkas, informatif, dan ramah pengguna.

Menerbitkan dengan agen pemrograman? Instal hf CLI Skill agar agen Anda dapat menangani unggahan, kartu model, dan metadata untuk Anda.

⏳ Menyiapkan Model Anda untuk Rilis

Unggah Bobot Model

Saat mengunggah model ke Hub, ikuti praktik terbaik berikut:

  • Gunakan repositori terpisah untuk bobot model yang berbeda: Buat repositori individual untuk setiap varian dari arsitektur yang sama. Hal ini memungkinkan Anda mengelompokkannya ke dalam koleksi, yang lebih mudah dinavigasi daripada daftar direktori. Hal ini juga meningkatkan visibilitas karena setiap model memiliki URL-nya sendiri (hf.co/org/model-name), memudahkan pencarian, dan menyediakan jumlah unduhan untuk masing-masing model Anda. Contoh yang bagus adalah koleksi Qwen3-VL baru-baru ini yang menampilkan berbagai varian arsitektur VL.

  • Gunakan safetensors alih-alih pickle untuk serialisasi bobot.: safetensors lebih aman dan cepat daripada pickle atau pth Python. Jika Anda memiliki file pickle .bin, gunakan alat konversi bobot untuk mengonversinya.

Menulis Kartu Model yang Komprehensif

Kartu model yang dibuat dengan baik (README.md di repositori Anda) sangat penting untuk kemudahan penemuan, reproduktibilitas, dan berbagi yang efektif. Pastikan untuk mencakup:

  1. Konfigurasi Metadata: Bagian metadata (YAML) di bagian atas model card Anda sangat penting untuk pencarian dan kategorisasi. Sertakan:

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

    Jika Anda membuat README.md di Web UI, Anda akan melihat formulir dengan bidang metadata terpenting yang kami rekomendasikan πŸ€—.

    metadata template on the hub ui
    Form Metadata di UI Hub
  2. Deskripsi Model Rinci: Berikan penjelasan yang jelas tentang apa yang dilakukan model Anda, arsitekturnya, dan kasus penggunaan yang dimaksudkan. Bantu pengguna dengan cepat memutuskan apakah model tersebut sesuai dengan kebutuhan mereka.

  3. Contoh Penggunaan: Sediakan potongan kode yang jelas dan siap salin-jalankan untuk inferensi, penyesuaian halus, atau tugas umum lainnya. Minimalkan perubahan yang perlu dilakukan pengguna.

    Bonus: Tambahkan notebook.ipynb yang terstruktur dengan baik di repo untuk menunjukkan inferensi atau fine-tuning, sehingga pengguna dapat membukanya langsung di Google Colab dan Kaggle Notebooks.

    colab and kaggle button
    Tombol Penggunaan Google dan Kaggle
  4. Spesifikasi Teknis: Sertakan parameter pelatihan, kebutuhan perangkat keras, dan detail lain yang membantu pengguna menjalankan model secara efektif.

  5. Metriks Kinerja: Bagikan hasil benchmark dan evaluasi. Sertakan metrik kuantitatif dan contoh kualitatif untuk menunjukkan kekuatan dan keterbatasannya.

  6. Batasan dan Bias: Dokumentasikan batasan, bias, dan pertimbangan etika yang diketahui agar pengguna dapat membuat pilihan yang tepat.

Untuk membuat prosesnya lebih mulus, klik Import model card template untuk mengisi README.md dengan placeholder.

model card template button on the hub uimodel card template on the hub
Tombol untuk mengimpor templat kartu modelBagian dari template yang diimpor

Meningkatkan Kemudahan Penemuan dan Penggunaan Model

Untuk memaksimalkan jangkauan dan kegunaan:

  1. Integrasi Library: Tambahkan dukungan untuk salah satu dari banyak library yang terintegrasi dengan Hugging Face Hub (seperti transformers, diffusers, sentence-transformers, timm). Integrasi ini secara signifikan meningkatkan aksesibilitas model Anda dan menyediakan pengguna dengan potongan kode untuk bekerja dengan model Anda.

    Sebagai contoh, untuk menentukan bahwa model Anda bekerja dengan pustaka transformers:

    ---
    library_name: transformers
    ---
    code snippet tab
    Tab cuplikan kode

    Anda juga dapat mendaftarkan pustaka model Anda sendiri atau menambahkan dukungan Hub ke pustaka dan basis kode Anda, sehingga pengguna mengetahui cara mengunduh bobot model dari Hub.

    Kami menulis panduan ekstensif tentang praktik terbaik pengunggahan di sini.

    Menggunakan pustaka yang terdaftar juga memungkinkan Anda untuk melacak unduhan model Anda dari waktu ke waktu.

  2. Metadata yang Benar:

    • Tag Pipeline: Pilih pipeline tag yang tepat agar model Anda muncul di pencarian dan widget yang benar.

    Contoh tag pipeline yang umum:

    • text-generation - Untuk model bahasa yang menghasilkan teks

    • text-to-image - Untuk model generasi teks-ke-gambar

    • image-text-to-text - Untuk model bahasa-visi (VLM) yang menghasilkan teks

    • text-to-speech - Untuk model yang menghasilkan audio dari teks

    • Lisensi: Informasi lisensi sangat penting agar pengguna memahami cara penggunaan model.

  3. Makalah Penelitian: Jika model Anda memiliki makalah terkait, kutipkan di kartu model. Makalah tersebut akan disilangkan secara otomatis.

    ## References
    
    * [Model Paper](https://arxiv.org/abs/xxxx.xxxxx)
  4. Koleksi: Jika Anda merilis beberapa model atau varian terkait, kelompokkan mereka ke dalam koleksi. Koleksi membantu pengguna menemukan model terkait dan memahami hubungan antar versi.

  5. Demo: Buat Hugging Face Space dengan demo interaktif. Hal ini memungkinkan pengguna mencoba model Anda tanpa menulis kode. Anda juga dapat menghubungkan model dari Space agar muncul di antarmuka halaman model.

    ## Demo
    
    Try this model directly in your browser: [Space Demo](https://huggingface.co/spaces/username/model-demo)

    Saat Anda membuat demo, unduh model dari repositori Hub-nya (bukan dari sumber eksternal seperti Google Drive). Hal ini saling mengaitkan artefak dan meningkatkan visibilitas

  6. Versi Terkuantisasi: Pertimbangkan untuk mengunggah versi terkuantisasi (misalnya, GGUF) di repositori terpisah untuk meningkatkan aksesibilitas bagi pengguna dengan komputasi terbatas. Tautkan versi-versi ini menggunakan bidang metadata base_model pada kartu model terkuantisasi, dan dokumentasikan perbedaan kinerjanya.

    ---
    base_model: username/original-model
    base_model_relation: quantized
    ---
    model tree showcasing relations
    Pohon model yang menampilkan versi terkuantisasi
  7. Menghubungkan Dataset di Halaman Model: Hubungkan dataset di metadata Anda agar muncul langsung di halaman model Anda.

    ---
    datasets:
    - username/dataset
    - username/dataset-2
    ---
  8. Versi Model Baru: Jika model Anda merupakan pembaruan dari model yang sudah ada, nyatakannya di kartu model yang lebih lama. Hal ini akan menampilkan banner di halaman lama yang berisi tautan ke pembaruan tersebut.

    ---
    new_version: username/updated-model
    ---
  9. Contoh Visual: Untuk model generasi gambar atau video, sertakan contoh langsung di halaman model Anda menggunakan komponen kartu <Gallery>.

    <Gallery>
    ![Example 1](./images/example1.png)
    ![Example 2](./images/example2.png)
    </Gallery>
  10. Emisi Karbon: Jika memungkinkan, tentukan emisi karbon dari pelatihan.

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

Kontrol Akses dan Visibilitas

  1. Pengaturan Visibilitas: Saat siap membagikan model Anda, ubah statusnya menjadi publik di pengaturan model Anda. Sebelum melakukannya, periksa kembali semua dokumentasi dan contoh kode untuk memastikan akurasi dan kelengkapannya.

  2. Akses Terbatas: Jika model Anda memerlukan akses yang dikendalikan, gunakan fitur akses terbatas dan nyatakan dengan jelas kondisi yang harus dipenuhi oleh pengguna. Hal ini penting untuk model yang memiliki kekhawatiran penggunaan ganda atau pembatasan komersial.

🏁 Setelah Model Anda Dirilis

Rilis model yang sukses melampaui publikasi awalnya. Untuk menjaga kualitas dan memaksimalkan dampak:

Pemeliharaan dan Keterlibatan Komunitas

  1. Verifikasi Fungsionalitas: Setelah rilis, uji semua potongan kode di lingkungan bersih untuk memastikan mereka berfungsi sesuai harapan. Hal ini memastikan pengguna dapat menjalankan model Anda tanpa error atau kebingungan.

    Sebagai contoh, jika model Anda adalah LLM yang kompatibel dengan transformers:

    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)
  2. Bagikan Bagikan Bagikan: Sebagian besar pengguna menemukan model melalui media sosial, kanal obrolan (seperti Slack atau Discord), atau buletin. Bagikan tautan model Anda di ruang-ruang tersebut, dan tambahkan juga ke situs web atau repositori GitHub Anda.

    Semakin banyak kunjungan dan suka yang diterima model Anda, semakin tinggi posisinya di bagian Trending Hugging Face, sehingga membawa visibilitas yang lebih besar

  3. Interaksi Komunitas: Gunakan tab Komunitas untuk menjawab pertanyaan, menanggapi umpan balik, dan menyelesaikan masalah dengan cepat. Jelaskan hal-hal yang membingungkan, terima saran yang membantu, dan tutup utas yang tidak relevan agar diskusi tetap fokus.

Tambahkan Hasil Evaluasi

Jika Anda mengevaluasi pada salah satu dataset benchmark yang didukung di Hub, Anda dapat menambahkan hasil evaluasi ke repositori model Anda. Hal ini akan membuat skor benchmark terlihat langsung di halaman model dan papan peringkat benchmark di repositori dataset. Lihat dokumentasi Hasil Evaluasi untuk spesifikasi lengkap.

Untuk menambahkan hasil evaluasi, buat file YAML di folder .eval_results/ dari repositori model Anda. Setiap file merujuk pada dataset 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 harus cocok dengan tugas yang didefinisikan dalam eval.yaml dari dataset benchmark. Anda dapat menemukan benchmark yang tersedia beserta ID tugasnya dengan memeriksa file eval.yaml di repositori dataset benchmark seperti HLE.

Siapa pun di komunitas juga dapat mengirimkan hasil evaluasi ke model mana pun dengan membuka Pull Request. Skor yang dikirimkan oleh komunitas menampilkan lencana β€œcommunity” di halaman model. Untuk menyederhanakan proses ini, Anda dapat menggunakan repositori community-evals, yang menyediakan skrip dan keterampilan agen untuk mengekstrak skor dari kartu model dan membuat PR secara otomatis.

Melacak Penggunaan dan Dampak

  1. Metriks Penggunaan: Lacak unduhan dan suka untuk memahami jangkauan dan adopsi model Anda. Anda dapat melihat metrik total unduhan di pengaturan model Anda.

  2. Ulasan Kontribusi Komunitas: Periksa secara berkala repositori model Anda untuk kontribusi dari pengguna lain. Permintaan tarik (pull request) dan diskusi komunitas dapat memberikan umpan balik, ide, dan peluang kolaborasi yang berguna.

🏒 Fitur Enterprise

Langganan Hugging Face Team & Enterprise menawarkan kemampuan tambahan untuk tim dan organisasi:

  1. Kontrol Akses: Atur grup sumber daya untuk mengelola akses bagi tim atau pengguna tertentu. Hal ini memastikan izin yang tepat dan kolaborasi yang aman di seluruh organisasi Anda.

  2. Wilayah Penyimpanan: Pilih wilayah penyimpanan data (AS atau EU) untuk file model Anda guna memenuhi peraturan dan persyaratan kepatuhan data regional.

  3. Analitik Lanjutan: Gunakan Publisher Analytics untuk mendapatkan wawasan yang lebih mendalam tentang pola penggunaan model, unduhan, dan tren adopsi di seluruh organisasi Anda.

  4. Penyimpanan Diperluas: Akses kapasitas penyimpanan privat tambahan untuk menampung lebih banyak model dan artefak yang lebih besar seiring dengan berkembangnya portofolio model Anda.

  5. Artikel Blog Organisasi: Organisasi enterprise kini dapat menerbitkan artikel blog langsung di Hugging Face. Hal ini memungkinkan Anda membagikan rilis model, pembaruan riset, dan pengumuman kepada komunitas yang lebih luas, semuanya dari profil organisasi Anda.

Dengan mengikuti pedoman dan contoh ini, Anda akan membuat rilis model Anda di Hugging Face menjadi jelas, bermanfaat, dan berdampak. Hal ini membantu karya Anda menjangkau lebih banyak orang, memperkuat komunitas AI, dan meningkatkan visibilitas model Anda.

Kami tidak sabar untuk melihat apa yang akan Anda bagikan selanjutnya! πŸ€—

Update on GitHub