Model card adalah sebuah berkas yang bisa dibilang sama pentingnya dengan berkas model dan tokenizer dalam repositori model. Ini adalah definisi utama dari model, yang menjamin model dapat digunakan kembali oleh anggota komunitas lain dan hasilnya dapat direproduksi, serta menyediakan platform bagi anggota lain untuk membangun artefak mereka di atasnya.
Mendokumentasikan proses pelatihan dan evaluasi membantu orang lain memahami apa yang bisa diharapkan dari suatu model — dan memberikan informasi yang cukup tentang data yang digunakan serta pra-pemrosesan dan pasca-pemrosesan yang dilakukan memastikan bahwa keterbatasan, bias, dan konteks di mana model ini berguna atau tidak bisa diidentifikasi dan dipahami.
Oleh karena itu, membuat model card yang dengan jelas mendefinisikan model Anda adalah langkah yang sangat penting. Di sini, kami menyediakan beberapa tips yang akan membantu Anda. Pembuatan model card dilakukan melalui berkas README.md yang sudah Anda lihat sebelumnya, yang merupakan berkas Markdown.
Konsep “model card” berasal dari penelitian Google, pertama kali diperkenalkan dalam makalah “Model Cards for Model Reporting” oleh Margaret Mitchell dkk. Banyak informasi di sini yang berdasarkan makalah tersebut, dan kami menyarankan Anda membacanya untuk memahami mengapa model card sangat penting dalam dunia yang menghargai reproduktibilitas, penggunaan ulang, dan keadilan.
Model card biasanya dimulai dengan ringkasan singkat tingkat tinggi tentang tujuan model, diikuti dengan detail tambahan pada bagian-bagian berikut:
Mari kita lihat apa saja yang sebaiknya dimasukkan dalam masing-masing bagian ini.
Bagian ini memberikan detail dasar tentang model. Ini mencakup arsitektur, versi, apakah model ini diperkenalkan dalam makalah, apakah tersedia implementasi asli, penulisnya, dan informasi umum lainnya. Setiap hak cipta harus dicantumkan di sini. Informasi umum tentang prosedur pelatihan, parameter, dan peringatan penting juga bisa disebutkan di bagian ini.
Di sini Anda menjelaskan kasus penggunaan yang dimaksudkan untuk model ini, termasuk bahasa, bidang, dan domain tempat model ini bisa diterapkan. Bagian ini juga bisa mendokumentasikan area yang diketahui tidak cocok untuk model ini atau area di mana model kemungkinan besar tidak akan bekerja optimal.
Bagian ini harus menyertakan beberapa contoh cara menggunakan model. Ini bisa berupa penggunaan fungsi pipeline(), penggunaan kelas model dan tokenizer, atau cuplikan kode lain yang menurut Anda berguna.
Bagian ini harus menunjukkan dataset apa saja yang digunakan untuk melatih model. Deskripsi singkat mengenai dataset tersebut juga sangat membantu.
Di bagian ini Anda perlu mendeskripsikan semua aspek relevan dari pelatihan yang berguna untuk tujuan reproduktibilitas. Ini mencakup setiap pra-pemrosesan dan pasca-pemrosesan yang dilakukan terhadap data, serta detail seperti jumlah epoch, ukuran batch, learning rate, dan sebagainya.
Di sini Anda perlu menjelaskan metrik yang digunakan untuk evaluasi, dan faktor-faktor apa saja yang diukur. Menyebutkan metrik apa yang digunakan, pada dataset mana dan pada split dataset mana, memudahkan orang lain membandingkan performa model Anda dengan model lain. Informasi ini harus konsisten dengan bagian sebelumnya seperti pengguna dan tujuan yang dimaksudkan.
Terakhir, berikan informasi tentang seberapa baik performa model pada dataset evaluasi. Jika model menggunakan threshold keputusan, sebutkan nilai threshold yang digunakan saat evaluasi, atau berikan detail evaluasi pada berbagai threshold sesuai penggunaan yang dimaksudkan.
Lihat beberapa contoh model card yang dibuat dengan baik berikut ini:
Contoh lain dari berbagai organisasi dan perusahaan tersedia di sini.
Model card bukanlah persyaratan wajib saat mempublikasikan model, dan Anda tidak perlu menyertakan semua bagian yang disebutkan di atas saat membuatnya. Namun, dokumentasi eksplisit dari model hanya akan memberikan manfaat bagi pengguna di masa depan, jadi kami menyarankan Anda mengisi sebanyak mungkin bagian sesuai pengetahuan dan kemampuan Anda.
Jika Anda telah menjelajahi Hugging Face Hub, Anda mungkin telah melihat bahwa beberapa model masuk ke dalam kategori tertentu: Anda bisa memfilternya berdasarkan tugas, bahasa, pustaka, dan lainnya. Kategori ini ditentukan berdasarkan metadata yang Anda tambahkan di header model card.
Sebagai contoh, jika Anda melihat model card camembert-base, Anda akan melihat baris berikut di bagian header model card:
---
language: fr
license: mit
datasets:
- oscar
---Metadata ini diurai oleh Hugging Face Hub, yang kemudian mengidentifikasi model ini sebagai model berbahasa Prancis, berlisensi MIT, dan dilatih pada dataset Oscar.
Spesifikasi lengkap model card memungkinkan Anda menentukan bahasa, lisensi, tag, dataset, metrik, serta hasil evaluasi yang diperoleh model saat pelatihan.
< > Update on GitHub