Hugging Face's logo

Hub documentation

Template Kartu Model Beranotasi

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Template Kartu Model Beranotasi

Siap untuk menerbitkan? Lihat Model Release Checklist untuk langkah-langkah penting menuju rilis model yang ringkas, informatif, dan ramah pengguna.

Template

file modelcard_template.md

Arah

Mengisi kartu model secara lengkap memerlukan masukan dari beberapa peran yang berbeda. (Satu orang dapat memiliki lebih dari satu peran.) Kami akan merujuk peran-peran ini sebagai developer, yang menulis kode dan menjalankan pelatihan; sociotechnic, yang terampil dalam menganalisis interaksi antara teknologi dan masyarakat dalam jangka panjang (ini mencakup pengacara, etikus, sosiolog, atau advokat hak); dan project organizer, yang memahami cakupan dan jangkauan keseluruhan model, dapat mengisi setiap bagian kartu secara garis besar, dan yang bertindak sebagai kontak untuk pembaruan kartu model.

Petunjuk diberikan di bawah ini, dalam huruf miring.

Nama variabel template muncul dalam monospace.

Nama Model

Ringkasan Bagian: Berikan nama model dan ringkasan 1-2 kalimat tentang apa itu modelnya.

model_id

model_summary

Daftar Isi

Ringkasan Bagian: Sediakan ini dengan tautan ke setiap bagian, agar orang dapat dengan mudah berpindah-pindah/menggunakan file di lokasi lain dengan TOC yang dipertahankan/mencetak konten/dll.

Detail Model

Ringkasan Bagian: Bagian ini menyediakan informasi dasar tentang apa itu model, statusnya saat ini, dan asal-usulnya. Bagian ini harus berguna bagi siapa pun yang ingin merujuk ke model tersebut.

Deskripsi Model

model_description

Berikan detail dasar tentang model. Ini mencakup arsitektur, versi, apakah model tersebut diperkenalkan dalam sebuah paper, apakah implementasi aslinya tersedia, dan para pembuatnya. Hak cipta apa pun harus dicantumkan di sini. Informasi umum tentang prosedur pelatihan, parameter, dan disclaimer penting juga dapat disebutkan di bagian ini.

  • Dikembangkan oleh: developers

Daftarkan (dan idealnya tautkan ke) orang-orang yang membangun model tersebut.

  • Dibiayai oleh: funded_by

Daftarkan (dan idealnya tautkan ke) sumber pendanaan yang mendukung atau memungkinkan model ini secara finansial, komputasi, atau lainnya.

  • Dibagikan oleh [opsional]: shared_by

Daftarkan (dan idealnya tautkan ke) orang/organisasi yang membuat model tersedia secara online.

  • Jenis model: model_type

Anda dapat menamai “type” sebagai:

1. Metode Pengawasan/Pembelajaran

2. Jenis Machine Learning

3. Modalitas

  • Bahasa [NLP]: language

Gunakan bidang ini ketika sistem menggunakan atau memproses bahasa alami (bahasa manusia).

  • Lisensi: license

Nama dan tautan ke lisensi yang digunakan.

  • Model yang Disederhanakan [opsional]: base_model

Jika model ini memiliki model lain sebagai dasarnya, tautkan ke model tersebut di sini.

Sumber Model opsional

  • Repositori: repo
  • Makalah [opsional]: paper
  • Demo [opsional]: demo

Sediakan sumber agar pengguna dapat langsung melihat model dan detailnya. Jenis sumber daya tambahan – log pelatihan, pelajaran yang dipelajari, dll. – termasuk dalam bagian Informasi Lebih Lanjut. Jika Anda menyertakan satu hal untuk bagian ini, tautkan ke repositori.

Penggunaan

Ringkasan Bagian: Bagian ini membahas pertanyaan seputar bagaimana model dimaksudkan untuk digunakan dalam berbagai konteks penerapan, membahas pengguna yang dapat diprediksi dari model (termasuk mereka yang terdampak oleh model), dan menjelaskan penggunaan yang dianggap di luar cakupan atau penyalahgunaan model. Perhatikan bahwa bagian ini tidak dimaksudkan untuk mencakup detail penggunaan lisensi. Untuk itu, tautkan langsung ke lisensi.

Penggunaan Langsung

direct_use

Jelaskan bagaimana model dapat digunakan tanpa fine-tuning, post-processing, atau integrasi ke dalam pipeline. Disarankan untuk menyertakan contoh potongan kode.

Penggunaan Hilir opsional

downstream_use

Jelaskan bagaimana model ini dapat digunakan saat dihaluskan untuk tugas tertentu atau saat diintegrasikan ke dalam ekosistem atau aplikasi yang lebih besar. Disarankan untuk menyertakan contoh potongan kode.

Penggunaan di Luar Cakupan

out_of_scope_use

Daftarkan bagaimana model dapat diprediksi disalahgunakan (digunakan dengan cara yang tidak akan berfungsi) dan jelaskan apa yang tidak boleh dilakukan pengguna terhadap model.

Bias, Risiko, dan Keterbatasan

Ringkasan Bagian: Bagian ini mengidentifikasi bahaya yang dapat diprediksi, kesalahpahaman, serta keterbatasan teknis dan sosioteknis. Bagian ini juga menyediakan informasi mengenai peringatan dan potensi mitigasi. Bias, risiko, dan keterbatasan terkadang tidak dapat dipisahkan/menunjuk pada masalah yang sama. Secara umum, bias dan risiko bersifat sosioteknis, sedangkan keterbatasan bersifat teknis:

  • Bias adalah stereotip atau kinerja yang tidak proporsional (skew) untuk beberapa subpopulasi.
  • Risiko adalah isu yang relevan secara sosial yang mungkin disebabkan oleh model.
  • Batasan adalah mode kegagalan yang mungkin terjadi dan dapat ditangani mengikuti Rekomendasi yang tercantum.

bias_risks_limitations

Apa saja masalah yang diketahui atau dapat diprediksi yang timbul dari model ini?

Rekomendasi

bias_recommendations

Apa rekomendasi terkait masalah yang dapat diprediksi? Hal ini dapat mencakup segala hal mulai dari “downsample gambar Anda” hingga memfilter konten eksplisit.

Detail Pelatihan

Ringkasan Bagian: Bagian ini menyediakan informasi untuk mendeskripsikan dan mereplikasi pelatihan, termasuk data pelatihan, kecepatan dan ukuran elemen pelatihan, serta dampak lingkungan dari pelatihan. Bagian ini sangat berkaitan dengan Spesifikasi Teknis, dan konten di sini harus menautkan ke bagian tersebut ketika relevan dengan prosedur pelatihan. Bagian ini berguna bagi orang-orang yang ingin mempelajari lebih lanjut tentang input model dan jejak pelatihan. Bagian ini relevan bagi siapa pun yang ingin mengetahui dasar-dasar apa yang dipelajari oleh model.

Data Pelatihan

training_data

Tuliskan 1-2 kalimat tentang apa data latihannya. Idealnya, ini berisi tautan ke Dataset Card untuk informasi lebih lanjut. Tautan ke dokumentasi terkait pra-pemrosesan data atau penyaringan tambahan juga dapat diletakkan di sini maupun di Informasi Lebih Lanjut.

Prosedur Pelatihan opsional

Pra-pemrosesan

preprocessing

Detail tokenisasi, pengubahan ukuran/penulisan ulang (tergantung pada modalitas), dll.

Kecepatan, Ukuran, Waktu

speeds_sizes_times

Detail throughput, waktu mulai/berakhir, ukuran checkpoint, dll.

Evaluasi

Ringkasan Bagian: Bagian ini menjelaskan protokol evaluasi, apa yang diukur dalam evaluasi, dan menyajikan hasilnya. Evaluasi idealnya memiliki setidaknya dua bagian, dengan satu bagian yang berfokus pada pengukuran kuantitatif kinerja umum (Data Pengujian, Faktor & Metrik), seperti yang dapat dilakukan melalui benchmarking; dan bagian lain yang berfokus pada kinerja terkait isu keselamatan sosial tertentu (Penilaian Dampak Sosial), seperti yang dapat dilakukan melalui red-teaming. Anda juga dapat menentukan hasil evaluasi model Anda dengan cara terstruktur dalam metadata kartu model. Hasil akan diparsing oleh Hub dan ditampilkan dalam widget di halaman model. Lihat https://huggingface.co/docs/hub/model-cards#evaluation-results.

Menguji Data, Faktor & Metrik

Evaluasi idealnya disagregasi berdasarkan faktor-faktor yang berbeda, seperti tugas, domain, dan subgrup populasi; serta dihitung dengan metrik yang paling bermakna untuk konteks penggunaan yang dapat diprediksi. Kinerja evaluasi yang setara di antara subgrup yang berbeda disebut “adil” di antara subgrup tersebut; metrik keadilan yang ditargetkan harus ditentukan berdasarkan kesalahan mana yang lebih mungkin menjadi bermasalah mengingat penggunaan model. Namun, bagian ini paling umum digunakan untuk melaporkan kinerja evaluasi agregat pada berbagai benchmark tugas.

Menguji Data

testing_data

Uraikan data pengujian atau tautkan ke Kartu Dataset-nya.

Faktor

testing_factors

Karakteristik apa yang dapat diprediksi akan memengaruhi perilaku model? Evaluasi sebaiknya dipecah berdasarkan faktor-faktor ini untuk mengungkap disparitas dalam kinerja.

Metrik

testing_metrics

Metriks apa yang akan digunakan untuk evaluasi?

Hasil

results

Hasil harus didasarkan pada Faktor dan Metrik yang didefinisikan di atas.

Ringkasan

results_summary

Apa yang dikatakan oleh hasil? Ini dapat berfungsi sebagai semacam ringkasan singkat untuk audiens umum.

Penilaian Dampak Sosial opsional

Gunakan bagian teks bebas ini untuk menjelaskan bagaimana model ini dievaluasi untuk risiko bahaya sosial, seperti untuk keselamatan anak, NCII, privasi, dan kekerasan. Hal ini dapat berupa jawaban atas pertanyaan-pertanyaan berikut:

  • Apakah model ini aman digunakan oleh anak-anak? Mengapa?
  • Apakah model ini telah diuji untuk mengevaluasi risiko terkait gambar intim non-konsensual (termasuk CSEM)?
  • Apakah model ini telah diuji untuk mengevaluasi risiko terkait aktivitas kekerasan, atau penggambaran kekerasan? Apa hasilnya?

Angka kuantitatif untuk setiap masalah juga dapat disediakan.

Pemeriksaan Model opsional

Ringkasan Bagian: Ini adalah bagian eksperimental yang mulai ditambahkan oleh beberapa pengembang, tempat kerja terkait explainability/interpretability dapat dilakukan.

model_examination

Dampak Lingkungan

Ringkasan Bagian: Merangkum informasi yang diperlukan untuk menghitung dampak lingkungan seperti penggunaan listrik dan emisi karbon.

  • Jenis Perangkat Keras: hardware_type
  • Jam yang digunakan: hours_used
  • Penyedia Cloud: cloud_provider
  • Wilayah Komputasi: cloud_region
  • Emisi Karbon: co2_emitted

Emisi karbon dapat diperkirakan menggunakan penghitung Machine Learning Impact yang disajikan dalam Lacoste et al. (2019).

Spesifikasi Teknis opsional

Ringkasan Bagian: Bagian ini mencakup detail tentang tujuan dan arsitektur model, serta infrastruktur komputasi. Bagian ini berguna bagi orang-orang yang tertarik dengan pengembangan model. Penulisan bagian ini biasanya memerlukan keterlibatan langsung dari pengembang model.

Arsitektur Model dan Tujuan

model_specs

Infrastruktur Komputasi

compute_infrastructure

Perangkat Keras

hardware_requirements

Bagaimana persyaratan minimum perangkat keras, misalnya persyaratan pemrosesan, penyimpanan, dan memori?

Perangkat lunak

software

Sitasi opsional

Ringkasan Bagian: Sitasi yang disukai pengembang untuk model ini. Ini biasanya berupa makalah.

BibTeX

citation_bibtex

APA

citation_apa

Glosarium opsional

Ringkasan Bagian: Bagian ini mendefinisikan istilah-istilah umum dan bagaimana metrik dihitung.

glossary

Tentukan definisi istilah secara jelas agar dapat dipahami oleh berbagai kalangan.

Informasi tambahan opsional

Ringkasan Bagian: Bagian ini menyediakan tautan ke tulisan tentang pembuatan dataset, spesifikasi teknis, pelajaran yang dipelajari, dan hasil awal.

more_information

Penulis Kartu Model opsional

Ringkasan Bagian: Bagian ini mencantumkan orang-orang yang membuat kartu model, memberikan pengakuan dan akuntabilitas untuk kerja detail yang terlibat dalam pembuatannya.

model_card_authors

Kontak Kartu Model

Ringkasan Bagian: Menyediakan cara bagi orang-orang yang memiliki pembaruan untuk Model Card, saran, atau pertanyaan, untuk menghubungi penulis Model Card

model_card_contact

Cara Memulai dengan Model

Ringkasan Bagian: Menyediakan potongan kode untuk menunjukkan cara menggunakan model.

get_started_code

Silakan kutip sebagai: 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

←Pertanyaan yang Sering Diajukan Panduan Kartu Model→