# Kartu Repositori

Perpustakaan huggingface_hub menyediakan antarmuka Python untuk membuat, membagikan, dan memperbarui Kartu Model/Dataset. Kunjungi [halaman dokumentasi khusus](https://huggingface.co/docs/hub/models-cards) untuk melihat lebih dalam tentang apa itu Kartu Model di Hub, dan bagaimana cara kerjanya di balik layar. Anda juga dapat melihat [panduan Kartu Model](../how-to-model-cards) kami untuk memahami bagaimana Anda dapat menggunakan utilitas ini dalam proyek Anda sendiri.

## Kartu Repo[[huggingface_hub.RepoCard]]

Objek `RepoCard` adalah kelas induk dari [ModelCard](/docs/huggingface_hub/v2.4.0/id/package_reference/cards#huggingface_hub.ModelCard), [DatasetCard](/docs/huggingface_hub/v2.4.0/id/package_reference/cards#huggingface_hub.DatasetCard), dan `SpaceCard`.

#### huggingface_hub.RepoCard[[huggingface_hub.RepoCard]]

```python
huggingface_hub.RepoCard(content: str, ignore_metadata_errors: bool = False)
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard.py#L37)

#### __init__[[huggingface_hub.RepoCard.__init__]]

```python
__init__(content: str, ignore_metadata_errors: bool = False)
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard.py#L42)

**Parameter:**

content (`str`) : Isi dari file Markdown.

Inisialisasi RepoCard dari konten string. Konten harus berupa file Markdown dengan blok YAML di bagian awal dan badan Markdown.

Contoh:
```python
>>> from huggingface_hub.repocard import RepoCard
>>> text = '''
... ---
... language: en
... license: mit
... ---
...
... # My repo
... '''
>>> card = RepoCard(text)
>>> card.data.to_dict()
{'language': 'en', 'license': 'mit'}
>>> card.text
'\n# My repo\n'

```

> [!TIP]
> Membangkitkan error berikut:
>
> - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) ketika konten metadata kartu repo bukan berupa kamus.

#### from_template[[huggingface_hub.RepoCard.from_template]]

```python
from_template(card_data: CardData, template_path: str | None = None, template_str: str | None = None, **template_kwargs)
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard.py#L289)

**Parameter:**

card_data (`huggingface_hub.CardData`) : Instans huggingface_hub.CardData yang berisi metadata yang ingin Anda sertakan dalam header YAML kartu repo di Hugging Face Hub.

template_path (`str`, *opsional*) : Path ke file markdown dengan variabel template Jinja opsional yang dapat diisi dengan `template_kwargs`. Default ke template default.

template_str (`str`, *opsional*) : String template Jinja mentah dengan variabel opsional. Digunakan ketika `template_path` maupun template default tidak sesuai. Diabaikan jika `template_path` juga disediakan.

**Mengembalikan:** [huggingface_hub.repocard.RepoCard](/docs/huggingface_hub/v2.4.0/id/package_reference/cards#huggingface_hub.RepoCard)

Instans RepoCard dengan data kartu dan konten dari template yang ditentukan.

Inisialisasi RepoCard dari sebuah template. Secara default, menggunakan template default.

Templates adalah template Jinja2 yang dapat dikustomisasi dengan meneruskan argumen kata kunci.

#### load[[huggingface_hub.RepoCard.load]]

```python
load(repo_id_or_path: str | pathlib.Path, repo_type: str | None = None, token: str | None = None, ignore_metadata_errors: bool = False)
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard.py#L135)

**Parameter:**

repo_id_or_path (`Union[str, Path]`) : ID repo yang terkait dengan repo Hugging Face Hub atau filepath lokal.

repo_type (`str`, *opsional*) : Jenis repo Hugging Face yang akan dituju untuk push. Defaultnya None, yang akan menggunakan "model". Opsi lainnya adalah "dataset" dan "space". Tidak digunakan saat memuat dari filepath lokal. Jika ini dipanggil dari kelas anak, nilai defaultnya akan menjadi `repo_type` dari kelas anak tersebut.

token (`str`, *opsional*) : Token autentikasi, diperoleh dengan metode `huggingface_hub.HfApi.login`. Akan menggunakan token yang tersimpan secara default.

ignore_metadata_errors (`str`) : Jika True, kesalahan saat parsing bagian metadata akan diabaikan. Beberapa informasi mungkin hilang selama proses tersebut. Gunakan dengan risiko Anda sendiri.

**Mengembalikan:** [huggingface_hub.repocard.RepoCard](/docs/huggingface_hub/v2.4.0/id/package_reference/cards#huggingface_hub.RepoCard)

RepoCard (atau subclass) yang diinisialisasi dari file README.md atau filepath repo.

Inisialisasi RepoCard dari README.md repo Hugging Face Hub atau filepath lokal.

Contoh:
```python
>>> from huggingface_hub.repocard import RepoCard
>>> card = RepoCard.load("nateraw/food")
>>> assert card.data.tags == ["generated_from_trainer", "image-classification", "pytorch"]

```

#### push_to_hub[[huggingface_hub.RepoCard.push_to_hub]]

```python
push_to_hub(repo_id: str, token: str | None = None, repo_type: str | None = None, commit_message: str | None = None, commit_description: str | None = None, revision: str | None = None, create_pr: bool | None = None, parent_commit: str | None = None)
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard.py#L226)

**Parameter:**

repo_id (`str`) : ID repo dari repo Hugging Face Hub yang akan dituju untuk push. Contoh: "nateraw/food".

token (`str`, *opsional*) : Token autentikasi, diperoleh dengan metode `huggingface_hub.HfApi.login`. Akan menggunakan token yang tersimpan secara default.

repo_type (`str`, *opsional*, defaultnya "model") : Jenis repo Hugging Face yang akan di-push. Opsinya adalah "model", "dataset", dan "space". Jika fungsi ini dipanggil oleh kelas anak, nilainya akan default ke `repo_type` dari kelas anak tersebut.

commit_message (`str`, *opsional*) : Ringkasan / judul / baris pertama dari commit yang dihasilkan.

commit_description (`str`, *opsional*) : Deskripsi dari commit yang dihasilkan.

revision (`str`, *opsional*) : Revisi git untuk di-commit. Secara default menggunakan head dari cabang `"main"`.

create_pr (`bool`, *opsional*) : Apakah akan membuat Pull Request dengan commit ini. Defaultnya adalah `False`.

parent_commit (`str`, *opsional*) : OID / SHA dari commit induk, sebagai string heksadesimal. Singkatan (7 karakter pertama) juga didukung. Jika ditentukan dan `create_pr` adalah `False`, commit akan gagal jika `revision` tidak menunjuk ke `parent_commit`. Jika ditentukan dan `create_pr` adalah `True`, pull request akan dibuat dari `parent_commit`. Menentukan `parent_commit` memastikan repo tidak berubah sebelum perubahan di-commit, dan dapat sangat berguna jika repo diperbarui / di-commit secara bersamaan.

**Mengembalikan:** `str`

URL dari commit yang memperbarui metadata kartu.

Dorong RepoCard ke repo Hugging Face Hub.

#### save[[huggingface_hub.RepoCard.save]]

```python
save(filepath: pathlib.Path | str)
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard.py#L115)

**Parameter:**

filepath (`Union[Path, str]`) : Filepath ke file markdown yang akan disimpan.

Simpan RepoCard ke file.

Contoh:
```python
>>> from huggingface_hub.repocard import RepoCard
>>> card = RepoCard("---\nlanguage: en\n---\n# This is a test repo card")
>>> card.save("/tmp/test.md")

```

#### validate[[huggingface_hub.RepoCard.validate]]

```python
validate(repo_type: str | None = None)
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard.py#L189)

**Parameter:**

repo_type (`str`, *opsional*, defaultnya "model") : Jenis repo Hugging Face yang akan di-push. Opsinya adalah "model", "dataset", dan "space". Jika fungsi ini dipanggil dari kelas anak, defaultnya akan menjadi `repo_type` dari kelas anak tersebut.

Memvalidasi kartu terhadap logika validasi kartu Hugging Face Hub. Penggunaan fungsi ini memerlukan akses ke internet, sehingga hanya dipanggil secara internal oleh [huggingface_hub.repocard.RepoCard.push_to_hub()](/docs/huggingface_hub/v2.4.0/id/package_reference/cards#huggingface_hub.RepoCard.push_to_hub).

> [!TIP]
> Membuang kesalahan berikut:
>
> - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) jika kartu gagal melewati pemeriksaan validasi. - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) jika permintaan ke API Hub gagal karena alasan lain.

## Data Kartu[[huggingface_hub.CardData]]

Objek [CardData](/docs/huggingface_hub/v2.4.0/id/package_reference/cards#huggingface_hub.CardData) adalah kelas induk dari [ModelCardData](/docs/huggingface_hub/v2.4.0/id/package_reference/cards#huggingface_hub.ModelCardData) dan [DatasetCardData](/docs/huggingface_hub/v2.4.0/id/package_reference/cards#huggingface_hub.DatasetCardData).

#### huggingface_hub.CardData[[huggingface_hub.CardData]]

```python
huggingface_hub.CardData(ignore_metadata_errors: bool = False, **kwargs)
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard_data.py#L165)

Struktur yang berisi metadata dari RepoCard.

[CardData](/docs/huggingface_hub/v2.4.0/id/package_reference/cards#huggingface_hub.CardData) adalah kelas induk dari [ModelCardData](/docs/huggingface_hub/v2.4.0/id/package_reference/cards#huggingface_hub.ModelCardData) dan [DatasetCardData](/docs/huggingface_hub/v2.4.0/id/package_reference/cards#huggingface_hub.DatasetCardData).

Metadata dapat diekspor sebagai dictionary atau YAML. Ekspor dapat dikustomisasi untuk mengubah representasi data (contoh: meratakan hasil evaluasi). `CardData` berperilaku seperti dictionary (dapat get, pop, set nilai) tetapi tidak mewarisi dari `dict` untuk memungkinkan langkah ekspor ini.

#### get[[huggingface_hub.CardData.get]]

```python
get(key: str, default: typing.Any = None)
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard_data.py#L228)

Dapatkan nilai untuk kunci metadata tertentu.

#### pop[[huggingface_hub.CardData.pop]]

```python
pop(key: str, default: typing.Any = None)
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard_data.py#L233)

Nilai Pop untuk kunci metadata tertentu.

#### to_dict[[huggingface_hub.CardData.to_dict]]

```python
to_dict()
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard_data.py#L178)

**Mengembalikan:** `dict`

CardData yang direpresentasikan sebagai kamus yang siap untuk dituangkan ke blok YAML untuk dimasukkan ke dalam file README.md.

Mengonversi CardData menjadi dict.

#### to_yaml[[huggingface_hub.CardData.to_yaml]]

```python
to_yaml(line_break = None, original_order: list[str] | None = None)
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard_data.py#L198)

**Parameter:**

line_break (str, *opsional*) : Baris pemisah yang digunakan saat menumpahkan ke yaml.

original_order (`list[str]`, *opsional*) : Jika diberikan, urutkan ulang bidang metadata agar sesuai dengan daftar ini sebelum dump. Kunci apa pun yang tidak ada di `original_order` akan ditambahkan setelah kunci yang terdaftar, dengan mempertahankan urutan relatif yang ada. Berguna untuk round-tripping blok YAML tanpa mengacak kuncinya.

**Mengembalikan:** `str`

CardData yang direpresentasikan sebagai blok YAML.

Menyimpan CardData ke dalam blok YAML untuk dimasukkan ke dalam file README.md.

## Kartu Model

### ModelCard[[huggingface_hub.ModelCard]]

#### huggingface_hub.ModelCard[[huggingface_hub.ModelCard]]

```python
huggingface_hub.ModelCard(content: str, ignore_metadata_errors: bool = False)
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard.py#L336)

#### from_template[[huggingface_hub.ModelCard.from_template]]

```python
from_template(card_data: ModelCardData, template_path: str | None = None, template_str: str | None = None, **template_kwargs)
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard.py#L341)

**Parameter:**

card_data (`huggingface_hub.ModelCardData`) : Instans huggingface_hub.ModelCardData yang berisi metadata yang ingin Anda sertakan dalam header YAML model card di Hugging Face Hub.

template_path (`str`, *opsional*) : Path ke file markdown dengan variabel template Jinja opsional yang dapat diisi dengan `template_kwargs`. Default ke template default.

template_str (`str`, *opsional*) : String template Jinja mentah dengan variabel opsional. Digunakan ketika `template_path` maupun template default tidak sesuai. Diabaikan jika `template_path` juga disediakan.

**Mengembalikan:** [huggingface_hub.ModelCard](/docs/huggingface_hub/v2.4.0/id/package_reference/cards#huggingface_hub.ModelCard)

Instans ModelCard dengan data kartu dan konten dari template yang ditentukan.

Inisialisasi ModelCard dari template. Secara default, menggunakan template default yang dapat ditemukan di sini: https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md

Templates adalah template Jinja2 yang dapat dikustomisasi dengan meneruskan argumen kata kunci.

Contoh:
```python
>>> from huggingface_hub import ModelCard, ModelCardData, EvalResult

>>> # Using the Default Template
>>> card_data = ModelCardData(
...     language='en',
...     license='mit',
...     library_name='timm',
...     tags=['image-classification', 'resnet'],
...     datasets=['beans'],
...     metrics=['accuracy'],
... )
>>> card = ModelCard.from_template(
...     card_data,
...     model_description='This model does x + y...'
... )

>>> # Including Evaluation Results
>>> card_data = ModelCardData(
...     language='en',
...     tags=['image-classification', 'resnet'],
...     eval_results=[
...         EvalResult(
...             task_type='image-classification',
...             dataset_type='beans',
...             dataset_name='Beans',
...             metric_type='accuracy',
...             metric_value=0.9,
...         ),
...     ],
...     model_name='my-cool-model',
... )
>>> card = ModelCard.from_template(card_data)

>>> # Using a Custom Template
>>> card_data = ModelCardData(
...     language='en',
...     tags=['image-classification', 'resnet']
... )
>>> card = ModelCard.from_template(
...     card_data=card_data,
...     template_path='./src/huggingface_hub/templates/modelcard_template.md',
...     custom_template_var='custom value',  # will be replaced in template if it exists
... )

```

### ModelCardData[[huggingface_hub.ModelCardData]]

#### huggingface_hub.ModelCardData[[huggingface_hub.ModelCardData]]

```python
huggingface_hub.ModelCardData(base_model: str | list[str] | None = None, datasets: str | list[str] | None = None, eval_results: list[huggingface_hub.repocard_data.EvalResult] | None = None, language: str | list[str] | None = None, library_name: str | None = None, license: str | None = None, license_name: str | None = None, license_link: str | None = None, metrics: list[str] | None = None, model_name: str | None = None, pipeline_tag: str | None = None, tags: list[str] | None = None, ignore_metadata_errors: bool = False, **kwargs)
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard_data.py#L271)

**Parameter:**

base_model (`str` atau `list[str]`, *opsional*) : Pengidentifikasi model dasar yang menjadi asal turunan model. Ini berlaku, misalnya, jika model Anda adalah fine-tune atau adapter dari model yang sudah ada. Nilainya harus berupa ID model di Hub (atau daftar ID jika model Anda diturunkan dari beberapa model). Defaultnya adalah None.

datasets (`Union[str, list[str]]`, *opsional*) : Dataset atau daftar dataset yang digunakan untuk melatih model ini. Harus berupa ID dataset yang ditemukan di https://hf.co/datasets. Bawaan adalah None.

eval_results (`Union[list[EvalResult], EvalResult]`, *opsional*) : Daftar `huggingface_hub.EvalResult` yang mendefinisikan hasil evaluasi model. Jika disediakan, `model_name` digunakan sebagai nama di papan peringkat PapersWithCode. Bawaan adalah `None`.

language (`Union[str, list[str]]`, *opsional*) : Bahasa dari data pelatihan atau metadata model. Harus berupa kode ISO 639-1, 639-2, atau 639-3 (dua/tiga huruf), atau nilai khusus seperti "code", "multilingual". Bawaan adalah `None`.

library_name (`str`, *opsional*) : Nama pustaka yang digunakan oleh model ini. Contoh: keras atau pustaka apa pun dari https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/model-libraries.ts. Bawaan adalah None.

license (`str`, *opsional*) : Lisensi model ini. Contoh: apache-2.0 atau lisensi apa pun dari https://huggingface.co/docs/hub/repositories-licenses. Bawaan adalah None.

license_name (`str`, *opsional*) : Nama lisensi model ini. Bawaan adalah None. Digunakan bersamaan dengan `license_link`. Lisensi umum (Apache-2.0, MIT, CC-BY-SA-4.0) tidak memerlukan nama. Dalam kasus tersebut, gunakan `license` sebagai gantinya.

license_link (`str`, *opsional*) : Tautan ke lisensi model ini. Bawaan adalah None. Digunakan bersamaan dengan `license_name`. Lisensi umum (Apache-2.0, MIT, CC-BY-SA-4.0) tidak memerlukan tautan. Dalam hal itu, gunakan `license` sebagai gantinya.

metrics (`list[str]`, *opsional*) : Daftar metrik yang digunakan untuk mengevaluasi model ini. Harus berupa nama metrik yang dapat ditemukan di https://hf.co/metrics. Contoh: 'accuracy'. Bawaan adalah None.

model_name (`str`, *opsional*) : Nama untuk model ini. Nama ini digunakan bersama `eval_results` untuk membangun `model-index` di dalam metadata kartu. Nama yang Anda berikan di sini akan digunakan di papan peringkat PapersWithCode. Jika None diberikan, maka nama repo digunakan sebagai nilai default. Defaultnya adalah None.

pipeline_tag (`str`, *opsional*) : Tag pipeline yang terkait dengan model. Contoh: "text-classification".

tags (`list[str]`, *opsional*) : Daftar tag untuk ditambahkan ke model Anda yang dapat digunakan saat memfilter di Hugging Face Hub. Bawaan adalah None.

ignore_metadata_errors (`str`) : Jika True, kesalahan saat parsing bagian metadata akan diabaikan. Beberapa informasi mungkin hilang selama proses tersebut. Gunakan dengan risiko Anda sendiri.

kwargs (`dict`, *opsional*) : Metadata tambahan yang akan ditambahkan ke kartu model. Bawaan adalah None.

Metadata Model Card yang digunakan oleh Hugging Face Hub saat disertakan di bagian atas README.md Anda

Contoh:
```python
>>> from huggingface_hub import ModelCardData
>>> card_data = ModelCardData(
...     language="en",
...     license="mit",
...     library_name="timm",
...     tags=['image-classification', 'resnet'],
... )
>>> card_data.to_dict()
{'language': 'en', 'license': 'mit', 'library_name': 'timm', 'tags': ['image-classification', 'resnet']}

```

## Kartu Dataset

Dataset cards juga dikenal sebagai Data Cards dalam komunitas ML.

### DatasetCard[[huggingface_hub.DatasetCard]]

#### huggingface_hub.DatasetCard[[huggingface_hub.DatasetCard]]

```python
huggingface_hub.DatasetCard(content: str, ignore_metadata_errors: bool = False)
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard.py#L420)

#### from_template[[huggingface_hub.DatasetCard.from_template]]

```python
from_template(card_data: DatasetCardData, template_path: str | None = None, template_str: str | None = None, **template_kwargs)
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard.py#L425)

**Parameter:**

card_data (`huggingface_hub.DatasetCardData`) : Instans huggingface_hub.DatasetCardData yang berisi metadata yang ingin Anda sertakan dalam header YAML kartu dataset di Hugging Face Hub.

template_path (`str`, *opsional*) : Path ke file markdown dengan variabel template Jinja opsional yang dapat diisi dengan `template_kwargs`. Default ke template default.

template_str (`str`, *opsional*) : String template Jinja mentah dengan variabel opsional. Digunakan ketika `template_path` maupun template default tidak sesuai. Diabaikan jika `template_path` juga disediakan.

**Mengembalikan:** [huggingface_hub.DatasetCard](/docs/huggingface_hub/v2.4.0/id/package_reference/cards#huggingface_hub.DatasetCard)

Instans DatasetCard dengan data kartu dan konten dari template yang ditentukan.

Inisialisasi DatasetCard dari template. Secara default, menggunakan template default yang dapat ditemukan di sini: https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md

Templates adalah template Jinja2 yang dapat dikustomisasi dengan meneruskan argumen kata kunci.

Contoh:
```python
>>> from huggingface_hub import DatasetCard, DatasetCardData

>>> # Using the Default Template
>>> card_data = DatasetCardData(
...     language='en',
...     license='mit',
...     annotations_creators='crowdsourced',
...     task_categories=['text-classification'],
...     task_ids=['sentiment-classification', 'text-scoring'],
...     multilinguality='monolingual',
...     pretty_name='My Text Classification Dataset',
... )
>>> card = DatasetCard.from_template(
...     card_data,
...     pretty_name=card_data.pretty_name,
... )

>>> # Using a Custom Template
>>> card_data = DatasetCardData(
...     language='en',
...     license='mit',
... )
>>> card = DatasetCard.from_template(
...     card_data=card_data,
...     template_path='./src/huggingface_hub/templates/datasetcard_template.md',
...     custom_template_var='custom value',  # will be replaced in template if it exists
... )

```

### DatasetCardData[[huggingface_hub.DatasetCardData]]

#### huggingface_hub.DatasetCardData[[huggingface_hub.DatasetCardData]]

```python
huggingface_hub.DatasetCardData(language: str | list[str] | None = None, license: str | list[str] | None = None, annotations_creators: str | list[str] | None = None, language_creators: str | list[str] | None = None, multilinguality: str | list[str] | None = None, size_categories: str | list[str] | None = None, source_datasets: list[str] | None = None, task_categories: str | list[str] | None = None, task_ids: str | list[str] | None = None, paperswithcode_id: str | None = None, pretty_name: str | None = None, train_eval_index: dict | None = None, config_names: str | list[str] | None = None, ignore_metadata_errors: bool = False, **kwargs)
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard_data.py#L400)

**Parameter:**

language (`list[str]`, *opsional*) : Bahasa data atau metadata dataset. Harus berupa kode ISO 639-1, 639-2, atau 639-3 (dua/tiga huruf), atau nilai khusus seperti "code", "multilingual".

license (`Union[str, list[str]]`, *opsional*) : Lisensi dari dataset ini. Contoh: apache-2.0 atau lisensi apa pun dari https://huggingface.co/docs/hub/repositories-licenses.

annotations_creators (`Union[str, list[str]]`, *opsional*) : Bagaimana anotasi untuk dataset tersebut dibuat. Opsi yang tersedia: 'found', 'crowdsourced', 'expert-generated', 'machine-generated', 'no-annotation', 'other'.

language_creators (`Union[str, list[str]]`, *opsional*) : Bagaimana data berbasis teks dalam dataset tersebut dibuat. Opsi yang tersedia: 'found', 'crowdsourced', 'expert-generated', 'machine-generated', 'other'

multilinguality (`Union[str, list[str]]`, *opsional*) : Apakah dataset bersifat multibahasa. Opsi yang tersedia: 'monolingual', 'multilingual', 'translation', 'other'.

size_categories (`Union[str, list[str]]`, *opsional*) : Jumlah contoh dalam dataset. Opsi yang tersedia: 'n<1K', '1K1T', dan 'other'.

source_datasets (`list[str]]`, *opsional*) : Menunjukkan apakah dataset tersebut merupakan dataset asli atau diperluas dari dataset lain yang sudah ada. Opsinya adalah: 'original' dan 'extended'.

task_categories (`Union[str, list[str]]`, *opsional*) : Kategori tugas apa saja yang didukung oleh dataset?

task_ids (`Union[str, list[str]]`, *opsional*) : Tugas spesifik apa yang didukung oleh dataset?

paperswithcode_id (`str`, *opsional*) : ID dataset di PapersWithCode.

pretty_name (`str`, *opsional*) : Nama dataset yang lebih mudah dibaca manusia. (mis. "Cats vs. Dogs")

train_eval_index (`dict`, *opsional*) : Kamus yang menjelaskan spesifikasi yang diperlukan untuk melakukan evaluasi di Hub. Jika tidak disediakan, informasi ini akan diambil dari kunci 'train-eval-index' pada kwargs.

config_names (`Union[str, list[str]]`, *opsional*) : Daftar konfigurasi dataset yang tersedia untuk dataset tersebut.

Metadata Kartu Dataset yang digunakan oleh Hugging Face Hub saat disertakan di bagian atas README.md Anda

## Kartu Ruang

### SpaceCard[[huggingface_hub.SpaceCard]]

#### huggingface_hub.SpaceCard[[huggingface_hub.SpaceCard]]

```python
huggingface_hub.SpaceCard(content: str, ignore_metadata_errors: bool = False)
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard.py#L488)

### SpaceCardData[[huggingface_hub.SpaceCardData]]

#### huggingface_hub.SpaceCardData[[huggingface_hub.SpaceCardData]]

```python
huggingface_hub.SpaceCardData(title: str | None = None, sdk: str | None = None, sdk_version: str | None = None, python_version: str | None = None, app_file: str | None = None, app_port: int | None = None, license: str | None = None, duplicated_from: str | None = None, models: list[str] | None = None, datasets: list[str] | None = None, tags: list[str] | None = None, ignore_metadata_errors: bool = False, **kwargs)
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard_data.py#L480)

**Parameter:**

title (`str`, *opsional*) : Judul dari Space.

sdk (`str`, *opsional*) : SDK dari Space (salah satu dari `gradio`, `streamlit`, `docker`, atau `static`).

sdk_version (`str`, *opsional*) : Versi SDK yang digunakan (jika SDK Gradio/Streamlit).

python_version (`str`, *opsional*) : versi Python yang digunakan di Space (jika Gradio/Streamlit sdk).

app_file (`str`, *opsional*) : Path ke file aplikasi utama Anda (yang berisi kode Python gradio atau streamlit, atau kode html statis). Path bersifat relatif terhadap root dari repository.

app_port (`str`, *opsional*) : Port tempat aplikasi Anda berjalan. Hanya digunakan jika sdk adalah `docker`.

license (`str`, *opsional*) : Lisensi model ini. Contoh: apache-2.0 atau lisensi apa pun dari https://huggingface.co/docs/hub/repositories-licenses.

duplicated_from (`str`, *opsional*) : ID dari Space asli jika ini adalah duplikat Space.

models (`list[str]`, *opsional*) : Daftar model yang terkait dengan Space ini. Harus berupa ID dataset yang ditemukan di https://hf.co/models.

datasets (`list[str]`, *opsional*) : Daftar dataset yang terkait dengan Space ini. Harus berupa ID dataset yang ditemukan di https://hf.co/datasets.

tags (`list[str]`, *opsional*) : Daftar tag untuk ditambahkan ke Space Anda yang dapat digunakan saat memfilter di Hub.

ignore_metadata_errors (`str`) : Jika True, kesalahan saat parsing bagian metadata akan diabaikan. Beberapa informasi mungkin hilang selama proses tersebut. Gunakan dengan risiko Anda sendiri.

kwargs (`dict`, *opsional*) : Metadata tambahan yang akan ditambahkan ke kartu space.

Metadata Kartu Ruang yang digunakan oleh Hugging Face Hub saat disertakan di bagian atas README.md Anda

Untuk mendapatkan referensi lengkap tentang konfigurasi Spaces, silakan kunjungi https://huggingface.co/docs/hub/spaces-config-reference#spaces-configuration-reference.

Contoh:
```python
>>> from huggingface_hub import SpaceCardData
>>> card_data = SpaceCardData(
...     title="Dreambooth Training",
...     license="mit",
...     sdk="gradio",
...     duplicated_from="multimodalart/dreambooth-training"
... )
>>> card_data.to_dict()
{'title': 'Dreambooth Training', 'sdk': 'gradio', 'license': 'mit', 'duplicated_from': 'multimodalart/dreambooth-training'}
```

## Utilitas

### EvalResult[[huggingface_hub.EvalResult]]

#### huggingface_hub.EvalResult[[huggingface_hub.EvalResult]]

```python
huggingface_hub.EvalResult(task_type: str, dataset_type: str, dataset_name: str, metric_type: str, metric_value: typing.Any, task_name: str | None = None, dataset_config: str | None = None, dataset_split: str | None = None, dataset_revision: str | None = None, dataset_args: dict[str, typing.Any] | None = None, metric_name: str | None = None, metric_config: str | None = None, metric_args: dict[str, typing.Any] | None = None, verified: bool | None = None, verify_token: str | None = None, source_name: str | None = None, source_url: str | None = None)
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard_data.py#L13)

**Parameter:**

task_type (`str`) : Pengenal tugas. Contoh: "image-classification".

dataset_type (`str`) : Pengidentifikasi dataset. Contoh: "common_voice". Gunakan id dataset dari https://hf.co/datasets.

dataset_name (`str`) : Nama yang mudah dibaca untuk dataset. Contoh: "Common Voice (French)".

metric_type (`str`) : Pengidentifikasi metrik. Contoh: "wer". Gunakan id metrik dari https://hf.co/metrics.

metric_value (`Any`) : Nilai metrik. Contoh: 0.9 atau "20.0 ± 1.2".

task_name (`str`, *opsional*) : Nama yang mudah dibaca untuk tugas. Contoh: "Speech Recognition".

dataset_config (`str`, *opsional*) : Nama konfigurasi dataset yang digunakan dalam `load_dataset()`. Contoh: fr dalam `load_dataset("common_voice", "fr")`. Lihat dokumentasi `datasets` untuk informasi lebih lanjut: https://hf.co/docs/datasets/package_reference/loading_methods#datasets.load_dataset.name

dataset_split (`str`, *opsional*) : Split yang digunakan dalam `load_dataset()`. Contoh: "test".

dataset_revision (`str`, *opsional*) : Revisi (AKA Git Sha) dari dataset yang digunakan dalam `load_dataset()`. Contoh: 5503434ddd753f426f4b38109466949a1217c2bb

dataset_args (`dict[str, Any]`, *opsional*) : Argumen yang diteruskan selama `Metric.compute()`. Contoh untuk `bleu`: `{"max_order": 4}`

metric_name (`str`, *opsional*) : Nama yang mudah dibaca untuk metrik. Contoh: "Test WER".

metric_config (`str`, *opsional*) : Nama konfigurasi metrik yang digunakan dalam `load_metric()`. Contoh: bleurt-large-512 dalam `load_metric("bleurt", "bleurt-large-512")`. Lihat dokumentasi `datasets` untuk informasi lebih lanjut: https://huggingface.co/docs/datasets/v2.1.0/en/loading#load-configurations

metric_args (`dict[str, Any]`, *opsional*) : Argumen yang diteruskan selama `Metric.compute()`. Contoh untuk `bleu`: max_order: 4

verified (`bool`, *opsional*) : Menunjukkan apakah metrik berasal dari [layanan evaluasi](https://huggingface.co/spaces/autoevaluate/model-evaluator) Hugging Face atau tidak. Dihitung secara otomatis oleh Hugging Face, jangan disetel.

verify_token (`str`, *opsional*) : JSON Web Token yang digunakan untuk memverifikasi apakah metrik berasal dari [layanan evaluasi](https://huggingface.co/spaces/autoevaluate/model-evaluator) Hugging Face atau tidak.

source_name (`str`, *opsional*) : Nama sumber dari hasil evaluasi. Contoh: "Open LLM Leaderboard".

source_url (`str`, *opsional*) : URL sumber hasil evaluasi. Contoh: "https://huggingface.co/spaces/open-llm-leaderboard/open_llm_leaderboard".

Representasi datar dari hasil evaluasi individual yang ditemukan di model-index dari Model Cards.

Untuk informasi lebih lanjut tentang spesifikasi model-index, lihat https://github.com/huggingface/hub-docs/blob/main/modelcard.md?plain=1.

#### is_equal_except_value[[huggingface_hub.EvalResult.is_equal_except_value]]

```python
is_equal_except_value(other: EvalResult)
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard_data.py#L145)

Kembalikan True jika `self` dan `other` menggambarkan metrik yang persis sama tetapi dengan nilai yang berbeda.

### model_index_to_eval_results[[huggingface_hub.repocard_data.model_index_to_eval_results]]

#### huggingface_hub.repocard_data.model_index_to_eval_results[[huggingface_hub.repocard_data.model_index_to_eval_results]]

```python
huggingface_hub.repocard_data.model_index_to_eval_results(model_index: list)
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard_data.py#L561)

**Parameter:**

model_index (`list[dict[str, Any]]`) : Struktur data indeks model, kemungkinan berasal dari file README.md di Hugging Face Hub.

**Mengembalikan:** model_name (`str`)

Nama model sebagaimana ditemukan dalam indeks model. Ini digunakan sebagai pengidentifikasi model di papan peringkat seperti PapersWithCode. eval_results (`list[EvalResult]`): Daftar objek `huggingface_hub.EvalResult` yang berisi metrik yang dilaporkan dalam model_index yang disediakan.

Menerima indeks model dan mengembalikan nama model serta daftar objek `huggingface_hub.EvalResult`.

Spesifikasi detail dari indeks model dapat ditemukan di sini: https://github.com/huggingface/hub-docs/blob/main/modelcard.md?plain=1

Contoh:
```python
>>> from huggingface_hub.repocard_data import model_index_to_eval_results
>>> # Define a minimal model index
>>> model_index = [
...     {
...         "name": "my-cool-model",
...         "results": [
...             {
...                 "task": {
...                     "type": "image-classification"
...                 },
...                 "dataset": {
...                     "type": "beans",
...                     "name": "Beans"
...                 },
...                 "metrics": [
...                     {
...                         "type": "accuracy",
...                         "value": 0.9
...                     }
...                 ]
...             }
...         ]
...     }
... ]
>>> model_name, eval_results = model_index_to_eval_results(model_index)
>>> model_name
'my-cool-model'
>>> eval_results[0].task_type
'image-classification'
>>> eval_results[0].metric_type
'accuracy'

```

### eval_results_to_model_index[[huggingface_hub.repocard_data.eval_results_to_model_index]]

#### huggingface_hub.repocard_data.eval_results_to_model_index[[huggingface_hub.repocard_data.eval_results_to_model_index]]

```python
huggingface_hub.repocard_data.eval_results_to_model_index(model_name: str, eval_results: list)
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard_data.py#L681)

**Parameter:**

model_name (`str`) : Nama model (mis. "my-cool-model"). Ini digunakan sebagai pengidentifikasi model di papan peringkat seperti PapersWithCode.

eval_results (`list[EvalResult]`) : Daftar objek `huggingface_hub.EvalResult` yang berisi metrik yang akan dilaporkan di model-index.

**Mengembalikan:** model_index (`list[dict[str, Any]]`)

eval_results yang dikonversi menjadi model-index.

Menerima nama model yang diberikan dan daftar `huggingface_hub.EvalResult` serta mengembalikan model-index yang valid dan kompatibel dengan format yang diharapkan oleh Hugging Face Hub.

Contoh:
```python
>>> from huggingface_hub.repocard_data import eval_results_to_model_index, EvalResult
>>> # Define minimal eval_results
>>> eval_results = [
...     EvalResult(
...         task_type="image-classification",  # Required
...         dataset_type="beans",  # Required
...         dataset_name="Beans",  # Required
...         metric_type="accuracy",  # Required
...         metric_value=0.9,  # Required
...     )
... ]
>>> eval_results_to_model_index("my-cool-model", eval_results)
[{'name': 'my-cool-model', 'results': [{'task': {'type': 'image-classification'}, 'dataset': {'name': 'Beans', 'type': 'beans'}, 'metrics': [{'type': 'accuracy', 'value': 0.9}]}]}]

```

### metadata_eval_result[[huggingface_hub.metadata_eval_result]]

#### huggingface_hub.metadata_eval_result[[huggingface_hub.metadata_eval_result]]

```python
huggingface_hub.metadata_eval_result(model_pretty_name: str, task_pretty_name: str, task_id: str, metrics_pretty_name: str, metrics_id: str, metrics_value: typing.Any, dataset_pretty_name: str, dataset_id: str, metrics_config: str | None = None, metrics_verified: bool = False, dataset_config: str | None = None, dataset_split: str | None = None, dataset_revision: str | None = None, metrics_verification_token: str | None = None)
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard.py#L560)

**Parameter:**

model_pretty_name (`str`) : Nama model dalam bahasa alami.

task_pretty_name (`str`) : Nama tugas dalam bahasa alami.

task_id (`str`) : Contoh: automatic-speech-recognition. ID tugas.

metrics_pretty_name (`str`) : Nama untuk metrik dalam bahasa alami. Contoh: Test WER.

metrics_id (`str`) : Contoh: wer. Sebuah id metrik dari https://hf.co/metrics.

metrics_value (`Any`) : Nilai dari metrik. Contoh: 20.0 atau "20.0 ± 1.2".

dataset_pretty_name (`str`) : Nama dataset dalam bahasa alami.

dataset_id (`str`) : Contoh: common_voice. ID dataset dari https://hf.co/datasets.

metrics_config (`str`, *opsional*) : Nama konfigurasi metrik yang digunakan dalam `load_metric()`. Contoh: bleurt-large-512 dalam `load_metric("bleurt", "bleurt-large-512")`.

metrics_verified (`bool`, *opsional*, defaultnya `False`) : Menunjukkan apakah metrik berasal dari [layanan evaluasi](https://huggingface.co/spaces/autoevaluate/model-evaluator) Hugging Face atau tidak. Dihitung secara otomatis oleh Hugging Face, jangan disetel.

dataset_config (`str`, *opsional*) : Contoh: fr. Nama konfigurasi dataset yang digunakan dalam `load_dataset()`.

dataset_split (`str`, *opsional*) : Contoh: test. Nama split dataset yang digunakan dalam `load_dataset()`.

dataset_revision (`str`, *opsional*) : Contoh: 5503434ddd753f426f4b38109466949a1217c2bb. Nama revisi dataset yang digunakan dalam `load_dataset()`.

metrics_verification_token (`bool`, *opsional*) : JSON Web Token yang digunakan untuk memverifikasi apakah metrik berasal dari [layanan evaluasi](https://huggingface.co/spaces/autoevaluate/model-evaluator) Hugging Face atau tidak.

**Mengembalikan:** `dict`

dict metadata dengan hasil dari model yang dievaluasi pada dataset.

Membuat dict metadata dengan hasil dari model yang dievaluasi pada dataset.

Contoh:
```python
>>> from huggingface_hub import metadata_eval_result
>>> results = metadata_eval_result(
...         model_pretty_name="RoBERTa fine-tuned on ReactionGIF",
...         task_pretty_name="Text Classification",
...         task_id="text-classification",
...         metrics_pretty_name="Accuracy",
...         metrics_id="accuracy",
...         metrics_value=0.2662102282047272,
...         dataset_pretty_name="ReactionJPEG",
...         dataset_id="julien-c/reactionjpeg",
...         dataset_config="default",
...         dataset_split="test",
... )
>>> results == {
...     'model-index': [
...         {
...             'name': 'RoBERTa fine-tuned on ReactionGIF',
...             'results': [
...                 {
...                     'task': {
...                         'type': 'text-classification',
...                         'name': 'Text Classification'
...                     },
...                     'dataset': {
...                         'name': 'ReactionJPEG',
...                         'type': 'julien-c/reactionjpeg',
...                         'config': 'default',
...                         'split': 'test'
...                     },
...                     'metrics': [
...                         {
...                             'type': 'accuracy',
...                             'value': 0.2662102282047272,
...                             'name': 'Accuracy',
...                             'verified': False
...                         }
...                     ]
...                 }
...             ]
...         }
...     ]
... }
True

```

### metadata_update[[huggingface_hub.metadata_update]]

#### huggingface_hub.metadata_update[[huggingface_hub.metadata_update]]

```python
huggingface_hub.metadata_update(repo_id: str, metadata: dict, repo_type: str | None = None, overwrite: bool = False, token: str | None = None, commit_message: str | None = None, commit_description: str | None = None, revision: str | None = None, create_pr: bool = False, parent_commit: str | None = None)
```

[Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard.py#L688)

**Parameter:**

repo_id (`str`) : Nama repositori.

metadata (`dict`) : Kamus yang berisi metadata yang akan diperbarui.

repo_type (`str`, *opsional*) : Atur ke `"dataset"` atau `"space"` jika memperbarui ke dataset atau space, `None` atau `"model"` jika memperbarui ke model. Default adalah `None`.

overwrite (`bool`, *opsional*, defaultnya `False`) : Jika diatur ke `True`, bidang yang sudah ada dapat ditimpa; jika tidak, upaya untuk menimpa bidang yang sudah ada akan menyebabkan error.

token (`str`, *opsional*) : Token autentikasi Hugging Face.

commit_message (`str`, *opsional*) : Ringkasan / judul / baris pertama dari commit yang dihasilkan. Bawaan adalah `f"Update metadata with huggingface_hub"`

commit_description (`str`, *opsional*) : Deskripsi dari commit yang dihasilkan

revision (`str`, *opsional*) : Revisi git untuk di-commit. Secara default menggunakan head dari cabang `"main"`.

create_pr (`boolean`, *opsional*) : Apakah akan membuat Pull Request dari `revision` dengan commit tersebut. Defaultnya adalah `False`.

parent_commit (`str`, *opsional*) : OID / SHA dari commit induk, sebagai string heksadesimal. Singkatan (7 karakter pertama) juga didukung. Jika ditentukan dan `create_pr` adalah `False`, commit akan gagal jika `revision` tidak menunjuk ke `parent_commit`. Jika ditentukan dan `create_pr` adalah `True`, pull request akan dibuat dari `parent_commit`. Menentukan `parent_commit` memastikan repo tidak berubah sebelum perubahan di-commit, dan dapat sangat berguna jika repo diperbarui / di-commit secara bersamaan.

**Mengembalikan:** `str`

URL dari commit yang memperbarui metadata kartu.

Memperbarui metadata di README.md dari sebuah repositori di Hugging Face Hub. Jika file README.md belum ada, file baru akan dibuat dengan metadata dan template ModelCard atau DatasetCard default. Untuk repo `space`, error akan dilempar karena Space tidak dapat ada tanpa file `README.md`.

Contoh:
```python
>>> from huggingface_hub import metadata_update
>>> metadata = {'model-index': [{'name': 'RoBERTa fine-tuned on ReactionGIF',
...             'results': [{'dataset': {'name': 'ReactionGIF',
...                                      'type': 'julien-c/reactiongif'},
...                           'metrics': [{'name': 'Recall',
...                                        'type': 'recall',
...                                        'value': 0.7762102282047272}],
...                          'task': {'name': 'Text Classification',
...                                   'type': 'text-classification'}}]}]}
>>> url = metadata_update("hf-internal-testing/reactiongif-roberta-card", metadata)

```