# Depo Kartları

huggingface_hub kütüphanesi, Model/Dataset Kartları oluşturma, paylaşma ve güncelleme için bir Python arayüzü sağlar. Hub'daki Model Kartlarının ne olduğunu ve altyapıda nasıl çalıştığını daha derinlemesine incelemek için [özel dokümantasyon sayfasını](https://huggingface.co/docs/hub/models-cards) ziyaret edebilirsiniz. Ayrıca bu araçları kendi projelerinizde nasıl kullanacağınızı kavramak için [Model Kartları kılavuzumuza](../how-to-model-cards) göz atabilirsiniz.

## Depo Kartı[[huggingface_hub.RepoCard]]

`RepoCard` nesnesi, [ModelCard](/docs/huggingface_hub/v2.4.0/tr/package_reference/cards#huggingface_hub.ModelCard), [DatasetCard](/docs/huggingface_hub/v2.4.0/tr/package_reference/cards#huggingface_hub.DatasetCard) ve `SpaceCard` sınıflarının üst sınıfıdır.

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

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

[Kaynak](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)
```

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

**Parametreler:**

content (`str`) : Markdown dosyasının içeriği.

Bir dize içeriğinden bir RepoCard başlatır. İçerik, başında bir YAML bloğu ve bir Markdown gövdesi olan bir Markdown dosyası olmalıdır.

Örnek:
```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]
> Aşağıdaki hatayı oluşturur:
>
> - Depo kartı meta verilerinin içeriği bir sözlük değilse [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError).

#### 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)
```

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

**Parametreler:**

card_data (`huggingface_hub.CardData`) : Hugging Face Hub'daki depo kartının YAML başlığına dahil etmek istediğiniz metadata'yı içeren bir huggingface_hub.CardData örneği.

template_path (`str`, *isteğe bağlı*) : `template_kwargs` ile doldurulabilecek isteğe bağlı Jinja şablon değişkenleri içeren bir markdown dosyasına yol. Varsayılan olarak varsayılan şablon kullanılır.

template_str (`str`, *isteğe bağlı*) : İsteğe bağlı değişkenlere sahip ham bir Jinja şablon dizesi. Ne `template_path` ne de varsayılan şablon uygun olduğunda kullanılır. `template_path` de sağlanıyorsa yok sayılır.

**Dönüş:** [huggingface_hub.repocard.RepoCard](/docs/huggingface_hub/v2.4.0/tr/package_reference/cards#huggingface_hub.RepoCard)

Belirtilen kart verisi ve şablondaki içeriğe sahip bir RepoCard örneği.

Bir şablon kullanarak bir RepoCard başlatın. Varsayılan olarak, varsayılan şablonu kullanır.

Şablonlar, anahtar kelime argümanları geçirilerek özelleştirilebilen Jinja2 şablonlarıdır.

#### 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)
```

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

**Parametreler:**

repo_id_or_path (`Union[str, Path]`) : Hugging Face Hub deposuyla ilişkili depo kimliği veya yerel dosya yolu.

repo_type (`str`, *isteğe bağlı*) : İtme işleminin yapılacağı Hugging Face deposunun türü. Varsayılan değeri None'dır ve bu durumda "model" kullanılır. Diğer seçenekler "dataset" ve "space"tir. Yerel bir dosya yolundan yüklenirken kullanılmaz. Bu, bir alt sınıftan çağrılıyorsa, varsayılan değer alt sınıfın `repo_type` değeri olacaktır.

token (`str`, *isteğe bağlı*) : `huggingface_hub.HfApi.login` yöntemiyle elde edilen kimlik doğrulama belirteci. Varsayılan olarak depolanan belirteç kullanılır.

ignore_metadata_errors (`str`) : True ise, metadata bölümünün ayrıştırılması sırasında oluşan hatalar yok sayılır. Bu işlem sırasında bazı bilgiler kaybolabilir. Kendi sorumluluğunuzda kullanın.

**Dönüş:** [huggingface_hub.repocard.RepoCard](/docs/huggingface_hub/v2.4.0/tr/package_reference/cards#huggingface_hub.RepoCard)

Depo README.md dosyasından veya dosya yolundan başlatılan RepoCard (veya alt sınıfı).

Bir Hugging Face Hub deposunun README.md dosyasından veya yerel bir dosya yolundan bir RepoCard başlatın.

Örnek:
```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)
```

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

**Parametreler:**

repo_id (`str`) : İtme işleminin yapılacağı Hugging Face Hub deposunun depo kimliği. Örnek: "nateraw/food".

token (`str`, *isteğe bağlı*) : `huggingface_hub.HfApi.login` yöntemiyle elde edilen kimlik doğrulama belirteci. Varsayılan olarak depolanan belirteç kullanılır.

repo_type (`str`, *isteğe bağlı*, varsayılan "model") : İtme yapılacak Hugging Face deposunun türü. Seçenekler "model", "dataset" ve "space"tir. Bu fonksiyon bir alt sınıf tarafından çağrılırsa, varsayılan olarak alt sınıfın `repo_type` değeri kullanılır.

commit_message (`str`, *isteğe bağlı*) : Oluşturulan commit'in özeti / başlığı / ilk satırı.

commit_description (`str`, *isteğe bağlı*) : Oluşturulan commit'in açıklaması.

revision (`str`, *isteğe bağlı*) : Commit'in alınacağı git revizyonu. Varsayılan olarak `"main"` dalının başıdır.

create_pr (`bool`, *isteğe bağlı*) : Bu commit ile bir Pull Request oluşturulup oluşturulmayacağı. Varsayılan olarak `False`'tir.

parent_commit (`str`, *isteğe bağlı*) : Ebeveyn commit'in OID / SHA'sı, onaltılık bir dize olarak. Kısaltmalar (ilk 7 karakter) de desteklenir. Belirtilirse ve `create_pr` `False` ise, `revision` `parent_commit`'e işaret etmiyorsa commit başarısız olur. Belirtilirse ve `create_pr` `True` ise, pull request `parent_commit`'ten oluşturulur. `parent_commit`'in belirtilmesi, değişiklikler commit edilmeden önce repoyun değişmediğinden emin olunmasını sağlar ve repo eşzamanlı olarak güncellenir / commit edilirse özellikle faydalı olabilir.

**Dönüş:** `str`

Kart meta verilerini güncelleyen commit'in URL'si.

Bir RepoCard'ı Hugging Face Hub deposuna gönderin.

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

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

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

**Parametreler:**

filepath (`Union[Path, str]`) : Kaydedilecek markdown dosyasının dosya yolu.

Bir RepoCard dosyasına kaydedin.

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

```

#### doğrula[[huggingface_hub.RepoCard.validate]]

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

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

**Parametreler:**

repo_type (`str`, *isteğe bağlı*, varsayılan "model") : İtme yapılacak Hugging Face deposunun türü. Seçenekler "model", "dataset" ve "space"tir. Bu fonksiyon bir alt sınıftan çağrılırsa, varsayılan değer alt sınıfın `repo_type` değeri olacaktır.

Hugging Face Hub'un kart doğrulama mantığına göre kartı doğrular. Bu işlevi kullanmak internet erişimi gerektirdiğinden, yalnızca [huggingface_hub.repocard.RepoCard.push_to_hub()](/docs/huggingface_hub/v2.4.0/tr/package_reference/cards#huggingface_hub.RepoCard.push_to_hub) tarafından dahili olarak çağrılır.

> [!TIP]
> Aşağıdaki hataları oluşturur:
>
> - Kart doğrulama kontrollerini geçemezse [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError). - Hub API'sine yapılan istek başka bir nedenle başarısız olursa [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError).

## Kart Verileri[[huggingface_hub.CardData]]

[CardData](/docs/huggingface_hub/v2.4.0/tr/package_reference/cards#huggingface_hub.CardData) nesnesi, [ModelCardData](/docs/huggingface_hub/v2.4.0/tr/package_reference/cards#huggingface_hub.ModelCardData) ve [DatasetCardData](/docs/huggingface_hub/v2.4.0/tr/package_reference/cards#huggingface_hub.DatasetCardData) sınıflarının üst sınıfıdır.

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

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

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

Bir RepoCard'dan gelen meta verileri içeren yapı.

[CardData](/docs/huggingface_hub/v2.4.0/tr/package_reference/cards#huggingface_hub.CardData), [ModelCardData](/docs/huggingface_hub/v2.4.0/tr/package_reference/cards#huggingface_hub.ModelCardData) ve [DatasetCardData](/docs/huggingface_hub/v2.4.0/tr/package_reference/cards#huggingface_hub.DatasetCardData) sınıflarının üst sınıfıdır.

Metadata, sözlük veya YAML olarak dışa aktarılabilir. Dışa aktarma, verinin temsilini değiştirmek için özelleştirilebilir (örnek: değerlendirme sonuçlarını düzleştirme). `CardData`, bir sözlük gibi davranır (değerleri alabilir, silebilir, ayarlayabilir) ancak bu dışa aktarma adımına izin vermek için `dict` sınıfından miras almaz.

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

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

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

Belirli bir meta veri anahtarı için değeri alın.

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

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

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

Belirli bir meta veri anahtarı için Pop değeri.

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

```python
to_dict()
```

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

**Dönüş:** `dict`

README.md dosyasına dahil edilmek üzere YAML bloğuna dönüştürülmeye hazır bir sözlük olarak temsil edilen CardData.

CardData'yı bir dict'e dönüştürür.

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

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

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

**Parametreler:**

line_break (str, *isteğe bağlı*) : yaml'e döküm sırasında kullanılacak satır sonu.

original_order (`list[str]`, *isteğe bağlı*) : Verilirse, döküm yapmadan önce metadata alanlarını bu listeye uygun şekilde yeniden sıralar. `original_order` içinde olmayan tüm anahtarlar, listelenen anahtarların ardından eklenir ve mevcut göreli sıraları korunur. Bir YAML bloğunun anahtarlarını karıştırmadan gidiş-dönüş işlemi yapmak için faydalıdır.

**Dönüş:** `str`

YAML bloğu olarak temsil edilen CardData.

CardData'yı bir README.md dosyasına dahil edilmek üzere bir YAML bloğuna yazar.

## Model Kartları

### ModelCard[[huggingface_hub.ModelCard]]

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

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

[Kaynak](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)
```

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

**Parametreler:**

card_data (`huggingface_hub.ModelCardData`) : Hugging Face Hub'daki model kartının YAML başlığına dahil etmek istediğiniz metadata'yı içeren bir huggingface_hub.ModelCardData örneği.

template_path (`str`, *isteğe bağlı*) : `template_kwargs` ile doldurulabilecek isteğe bağlı Jinja şablon değişkenleri içeren bir markdown dosyasına yol. Varsayılan olarak varsayılan şablon kullanılır.

template_str (`str`, *isteğe bağlı*) : İsteğe bağlı değişkenlere sahip ham bir Jinja şablon dizesi. Ne `template_path` ne de varsayılan şablon uygun olduğunda kullanılır. `template_path` de sağlanıyorsa yok sayılır.

**Dönüş:** [huggingface_hub.ModelCard](/docs/huggingface_hub/v2.4.0/tr/package_reference/cards#huggingface_hub.ModelCard)

Belirtilen kart verisi ve şablondaki içeriğe sahip bir ModelCard örneği.

Bir ModelCard'ı bir şablondan başlatır. Varsayılan olarak, buradan bulunabilen varsayılan şablonu kullanır: https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md

Şablonlar, anahtar kelime argümanları geçirilerek özelleştirilebilen Jinja2 şablonlarıdır.

Örnek:
```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)
```

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

**Parametreler:**

base_model (`str` veya `list[str]`, *isteğe bağlı*) : Modelin türediği temel modelin tanımlayıcısı. Modeliniz mevcut bir modelin ince ayarı veya adaptörü ise bu alan geçerlidir. Değer, Hub'daki bir modelin kimliği (veya modeliniz birden fazla modelden türediğinde kimliklerin listesi) olmalıdır. Varsayılan değeri None'dır.

datasets (`Union[str, list[str]]`, *isteğe bağlı*) : Bu modeli eğitmek için kullanılan veri seti veya veri setleri listesi. https://hf.co/datasets adresinde bulunan bir veri seti kimliği olmalıdır. Varsayılan değeri None'dır.

eval_results (`Union[list[EvalResult], EvalResult]`, *isteğe bağlı*) : Modelin değerlendirme sonuçlarını tanımlayan `huggingface_hub.EvalResult` listesidir. Sağlanırsa, `model_name`, PapersWithCode lider tablolarında ad olarak kullanılır. Varsayılan değeri `None`'dir.

language (`Union[str, list[str]]`, *isteğe bağlı*) : Modelin eğitim verisinin veya meta verisinin dili. ISO 639-1, 639-2 veya 639-3 kodu (iki/üç harf) veya "code", "multilingual" gibi özel bir değer olmalıdır. Varsayılan olarak `None`'dir.

library_name (`str`, *isteğe bağlı*) : Bu model tarafından kullanılan kütüphanenin adı. Örnek: keras veya https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/model-libraries.ts adresindeki herhangi bir kütüphane. Varsayılan olarak None'dır.

license (`str`, *isteğe bağlı*) : Bu modelin lisansı. Örnek: apache-2.0 veya https://huggingface.co/docs/hub/repositories-licenses adresindeki herhangi bir lisans. Varsayılan değeri None'dır.

license_name (`str`, *isteğe bağlı*) : Bu modelin lisansının adı. Varsayılan değeri None'dır. `license_link` ile birlikte kullanılmalıdır. Yaygın lisanslar (Apache-2.0, MIT, CC-BY-SA-4.0) için ad gerekmez. Bu durumda `license` kullanın.

license_link (`str`, *isteğe bağlı*) : Bu modelin lisansına bağlantı. Varsayılan olarak None'dir. `license_name` ile birlikte kullanılmalıdır. Yaygın lisanslar (Apache-2.0, MIT, CC-BY-SA-4.0) için bağlantı gerekmez. Bu durumda `license` kullanın.

metrics (`list[str]`, *isteğe bağlı*) : Bu modeli değerlendirmek için kullanılan metriklerin listesi. https://hf.co/metrics adresinde bulunabilen bir metrik adı olmalıdır. Örnek: 'accuracy'. Varsayılan değeri None'dır.

model_name (`str`, *isteğe bağlı*) : Bu model için bir ad. Kartın metadata'sı içinde `model-index` oluşturmak için `eval_results` ile birlikte kullanılır. Burada sağladığınız ad, PapersWithCode lider tablolarında kullanılacak olanıdır. None sağlanırsa varsayılan olarak depo adı kullanılır. Varsayılan olarak None'dır.

pipeline_tag (`str`, *isteğe bağlı*) : Modelle ilişkili olan pipeline etiketi. Örnek: "text-classification".

tags (`list[str]`, *isteğe bağlı*) : Hugging Face Hub üzerinde filtreleme yapılırken kullanılabilen, modelinize eklenecek etiketlerin listesi. Varsayılan olarak None'dır.

ignore_metadata_errors (`str`) : True ise, metadata bölümünün ayrıştırılması sırasında oluşan hatalar yok sayılır. Bu işlem sırasında bazı bilgiler kaybolabilir. Kendi sorumluluğunuzda kullanın.

kwargs (`dict`, *isteğe bağlı*) : Model kartına eklenecek ek meta veriler. Varsayılan olarak None'dir.

README.md dosyanızın başında yer aldığında Hugging Face Hub tarafından kullanılan Model Kartı Meta Verisi

Örnek:
```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']}

```

## Veri Seti Kartları

Veri seti kartları, ML topluluğunda Veri Kartları olarak da bilinir.

### DatasetCard[[huggingface_hub.DatasetCard]]

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

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

[Kaynak](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)
```

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

**Parametreler:**

card_data (`huggingface_hub.DatasetCardData`) : Hugging Face Hub'daki veri seti kartının YAML başlığına dahil etmek istediğiniz metadata'yı içeren bir huggingface_hub.DatasetCardData örneği.

template_path (`str`, *isteğe bağlı*) : `template_kwargs` ile doldurulabilecek isteğe bağlı Jinja şablon değişkenleri içeren bir markdown dosyasına yol. Varsayılan olarak varsayılan şablon kullanılır.

template_str (`str`, *isteğe bağlı*) : İsteğe bağlı değişkenlere sahip ham bir Jinja şablon dizesi. Ne `template_path` ne de varsayılan şablon uygun olduğunda kullanılır. `template_path` de sağlanıyorsa yok sayılır.

**Dönüş:** [huggingface_hub.DatasetCard](/docs/huggingface_hub/v2.4.0/tr/package_reference/cards#huggingface_hub.DatasetCard)

Belirtilen kart verisi ve şablondaki içeriğe sahip bir DatasetCard örneği.

Bir şablondan DatasetCard başlatın. Varsayılan olarak, buradan bulunabilen varsayılan şablonu kullanır: https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md

Şablonlar, anahtar kelime argümanları geçirilerek özelleştirilebilen Jinja2 şablonlarıdır.

Örnek:
```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)
```

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

**Parametreler:**

language (`list[str]`, *isteğe bağlı*) : Veri setinin verilerinin veya meta verilerinin dili. ISO 639-1, 639-2 veya 639-3 kodu (iki/üç harf) veya "code", "multilingual" gibi özel bir değer olmalıdır.

license (`Union[str, list[str]]`, *isteğe bağlı*) : Bu veri setinin lisans(lar)ı. Örnek: apache-2.0 veya https://huggingface.co/docs/hub/repositories-licenses adresindeki herhangi bir lisans.

annotations_creators (`Union[str, list[str]]`, *isteğe bağlı*) : Veri seti için etiketlerin nasıl oluşturulduğu. Seçenekler: 'found', 'crowdsourced', 'expert-generated', 'machine-generated', 'no-annotation', 'other'.

language_creators (`Union[str, list[str]]`, *isteğe bağlı*) : Veri setindeki metin tabanlı verilerin nasıl oluşturulduğunu belirtir. Seçenekler: 'found', 'crowdsourced', 'expert-generated', 'machine-generated', 'other'

multilinguality (`Union[str, list[str]]`, *isteğe bağlı*) : Veri setinin çok dilli olup olmadığı. Seçenekler: 'monolingual', 'multilingual', 'translation', 'other'.

size_categories (`Union[str, list[str]]`, *isteğe bağlı*) : Veri setindeki örnek sayısı. Seçenekler: 'n<1K', '1K1T' ve 'other'.

source_datasets (`list[str]]`, *isteğe bağlı*) : Veri setinin orijinal bir veri seti olup olmadığını veya başka mevcut bir veri setinden genişletilip genişletilmediğini belirtir. Seçenekler: 'original' ve 'extended'.

task_categories (`Union[str, list[str]]`, *isteğe bağlı*) : Veri seti hangi görev kategorilerini destekler?

task_ids (`Union[str, list[str]]`, *isteğe bağlı*) : Veri seti hangi belirli görevleri destekler?

paperswithcode_id (`str`, *isteğe bağlı*) : PapersWithCode'daki veri setinin kimliği.

pretty_name (`str`, *isteğe bağlı*) : Veri seti için daha insan okunabilir bir ad. (ör. "Cats vs. Dogs")

train_eval_index (`dict`, *isteğe bağlı*) : Hub üzerinde değerlendirme yapmak için gerekli olan spesifikasyonu tanımlayan bir sözlük. Sağlanmazsa, kwargs'nın 'train-eval-index' anahtarından toplanır.

config_names (`Union[str, list[str]]`, *isteğe bağlı*) : Veri seti için kullanılabilir veri seti yapılandırmalarının listesi.

README.md dosyasının başına eklendiğinde Hugging Face Hub tarafından kullanılan Dataset Card Metadata

## Space Kartları

### SpaceCard[[huggingface_hub.SpaceCard]]

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

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

[Kaynak](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)
```

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

**Parametreler:**

title (`str`, *isteğe bağlı*) : Space'in başlığı.

sdk (`str`, *isteğe bağlı*) : Space'in SDK'sı (`gradio`, `streamlit`, `docker` veya `static` değerlerinden biri).

sdk_version (`str`, *isteğe bağlı*) : Kullanılan SDK'nın sürümü (Gradio/Streamlit sdk ise).

python_version (`str`, *isteğe bağlı*) : Space'te kullanılan Python sürümü (Gradio/Streamlit sdk ise).

app_file (`str`, *isteğe bağlı*) : Ana uygulama dosyanızın yolu (gradio veya streamlit Python kodu ya da statik html kodu içeren). Yol, deposunun köküne göre göreli olarak verilir.

app_port (`str`, *isteğe bağlı*) : Uygulamanızın çalıştığı port. Yalnızca sdk `docker` ise kullanılır.

license (`str`, *isteğe bağlı*) : Bu modelin lisansı. Örnek: apache-2.0 veya https://huggingface.co/docs/hub/repositories-licenses adresindeki herhangi bir lisans.

duplicated_from (`str`, *isteğe bağlı*) : Bu bir kopyalanmış Space ise, orijinal Space'in kimliği.

models (`list[str]`, *isteğe bağlı*) : Bu Space ile ilişkili modellerin listesi. https://hf.co/models adresinde bulunan bir veri seti kimliği olmalıdır.

datasets (`list[str]`, *isteğe bağlı*) : Bu Space ile ilgili veri kümelerinin listesi. https://hf.co/datasets adresinde bulunan bir veri kümesi kimliği olmalıdır.

tags (`list[str]`, *isteğe bağlı*) : Hub'da filtreleme yapılırken kullanılabilen, Space'inize eklenecek etiketlerin listesi.

ignore_metadata_errors (`str`) : True ise, metadata bölümünün ayrıştırılması sırasında oluşan hatalar yok sayılır. Bu işlem sırasında bazı bilgiler kaybolabilir. Kendi sorumluluğunuzda kullanın.

kwargs (`dict`, *isteğe bağlı*) : Uzay kartına eklenecek ek meta veriler.

README.md dosyanızın başında yer aldığında Hugging Face Hub tarafından kullanılan Space Kart Meta Verisi

Spaces yapılandırmasının kapsamlı bir referansı için lütfen https://huggingface.co/docs/hub/spaces-config-reference#spaces-configuration-reference adresini ziyaret edin.

Örnek:
```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'}
```

## Yardımcılar

### 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)
```

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

**Parametreler:**

task_type (`str`) : Görev tanımlayıcısı. Örnek: "image-classification".

dataset_type (`str`) : Veri seti tanımlayıcısı. Örnek: "common_voice". https://hf.co/datasets adresindeki veri seti kimliğini kullanın.

dataset_name (`str`) : Veri seti için gösterge adı. Örnek: "Common Voice (French)".

metric_type (`str`) : Metrik tanımlayıcısı. Örnek: "wer". Metrik kimliğini https://hf.co/metrics adresinden kullanın.

metric_value (`Any`) : Metrik değeri. Örnek: 0.9 veya "20.0 ± 1.2".

task_name (`str`, *isteğe bağlı*) : Görev için gösterge adı. Örnek: "Speech Recognition".

dataset_config (`str`, *isteğe bağlı*) : `load_dataset()` içinde kullanılan veri seti yapılandırmasının adı. Örnek: `load_dataset("common_voice", "fr")` içindeki fr. Daha fazla bilgi için `datasets` belgelerine bakın: https://hf.co/docs/datasets/package_reference/loading_methods#datasets.load_dataset.name

dataset_split (`str`, *isteğe bağlı*) : `load_dataset()` içinde kullanılan bölme. Örnek: "test".

dataset_revision (`str`, *isteğe bağlı*) : `load_dataset()` içinde kullanılan veri setinin revizyonu (AKA Git Sha). Örnek: 5503434ddd753f426f4b38109466949a1217c2bb

dataset_args (`dict[str, Any]`, *isteğe bağlı*) : `Metric.compute()` sırasında geçirilen argümanlar. `bleu` için örnek: `{"max_order": 4}`

metric_name (`str`, *isteğe bağlı*) : Metrik için gösterge adı. Örnek: "Test WER".

metric_config (`str`, *isteğe bağlı*) : `load_metric()` içinde kullanılan metrik yapılandırmasının adı. Örnek: `load_metric("bleurt", "bleurt-large-512")` içindeki bleurt-large-512. Daha fazla bilgi için `datasets` belgelerine bakın: https://huggingface.co/docs/datasets/v2.1.0/en/loading#load-configurations

metric_args (`dict[str, Any]`, *isteğe bağlı*) : `Metric.compute()` sırasında geçirilen argümanlar. `bleu` için örnek: max_order: 4

verified (`bool`, *isteğe bağlı*) : Metriklerin Hugging Face'in [değerlendirme servisi](https://huggingface.co/spaces/autoevaluate/model-evaluator)nden mi yoksa başka bir kaynaktan mı geldiğini belirtir. Hugging Face tarafından otomatik olarak hesaplanır, elle ayarlamayın.

verify_token (`str`, *isteğe bağlı*) : Metriklerin Hugging Face'in [değerlendirme servisi](https://huggingface.co/spaces/autoevaluate/model-evaluator)nden mi yoksa başka bir yerden mi geldiğini doğrulamak için kullanılan bir JSON Web Token.

source_name (`str`, *isteğe bağlı*) : Değerlendirme sonucunun kaynağının adı. Örnek: "Open LLM Leaderboard".

source_url (`str`, *isteğe bağlı*) : Değerlendirme sonucunun kaynağının URL'si. Örnek: "https://huggingface.co/spaces/open-llm-leaderboard/open_llm_leaderboard".

Model Kartları'nın model-index bölümünde bulunan bireysel değerlendirme sonuçlarının düzleştirilmiş temsili.

model-index spec hakkında daha fazla bilgi için https://github.com/huggingface/hub-docs/blob/main/modelcard.md?plain=1 adresine bakın.

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

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

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

`self` ve `other` aynı metriği ancak farklı bir değerle tanımlıyorsa True döndürür.

### 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)
```

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

**Parametreler:**

model_index (`list[dict[str, Any]]`) : Muhtemelen Hugging Face Hub'daki bir README.md dosyasından gelen bir model indeksi veri yapısı.

**Dönüş:** model_name (`str`)

Model indekste bulunan modelin adı. Bu, PapersWithCode gibi liderlik tablolarında modelin tanımlayıcısı olarak kullanılır. eval_results (`list[EvalResult]`): Sağlanan model_index'te raporlanan metrikleri içeren `huggingface_hub.EvalResult` nesnelerinin listesi.

Bir model indeksi alır ve model adını ile `huggingface_hub.EvalResult` nesnelerinin listesini döndürür.

Model dizininin ayrıntılı bir spesifikasyonu burada bulunabilir: https://github.com/huggingface/hub-docs/blob/main/modelcard.md?plain=1

Örnek:
```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)
```

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

**Parametreler:**

model_name (`str`) : Modelin adı (ör. "my-cool-model"). Bu, PapersWithCode gibi liderlik tablolarında modelin tanımlayıcısı olarak kullanılır.

eval_results (`list[EvalResult]`) : model-index'te raporlanacak metrikleri içeren `huggingface_hub.EvalResult` nesnelerinin listesi.

**Dönüş:** model_index (`list[dict[str, Any]]`)

eval_results, model-index'e dönüştürüldü.

Verilen model adını ve `huggingface_hub.EvalResult` listesini alır ve Hugging Face Hub'ın beklediği formata uygun geçerli bir model-index döndürür.

Örnek:
```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)
```

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

**Parametreler:**

model_pretty_name (`str`) : Doğal dildeki model adı.

task_pretty_name (`str`) : Doğal dilde bir görevin adı.

task_id (`str`) : Örnek: automatic-speech-recognition. Bir görev kimliği.

metrics_pretty_name (`str`) : Metrik için doğal dilde bir ad. Örnek: Test WER.

metrics_id (`str`) : Örnek: wer. https://hf.co/metrics adresinden bir metrik kimliği.

metrics_value (`Any`) : Metrikten gelen değer. Örnek: 20.0 veya "20.0 ± 1.2".

dataset_pretty_name (`str`) : Doğal dildeki veri setinin adı.

dataset_id (`str`) : Örnek: common_voice. https://hf.co/datasets adresinden bir veri seti kimliği.

metrics_config (`str`, *isteğe bağlı*) : `load_metric()` içinde kullanılan metrik yapılandırmasının adı. Örnek: `load_metric("bleurt", "bleurt-large-512")` içindeki bleurt-large-512.

metrics_verified (`bool`, *isteğe bağlı*, varsayılan `False`) : Metriklerin Hugging Face'in [değerlendirme servisi](https://huggingface.co/spaces/autoevaluate/model-evaluator)nden mi yoksa başka bir kaynaktan mı geldiğini belirtir. Hugging Face tarafından otomatik olarak hesaplanır, ayarlamayın.

dataset_config (`str`, *isteğe bağlı*) : Örnek: fr. `load_dataset()` içinde kullanılan veri seti yapılandırmasının adı.

dataset_split (`str`, *isteğe bağlı*) : Örnek: test. `load_dataset()` içinde kullanılan veri seti bölmesinin adı.

dataset_revision (`str`, *isteğe bağlı*) : Örnek: 5503434ddd753f426f4b38109466949a1217c2bb. `load_dataset()` içinde kullanılan veri seti revizyonunun adı.

metrics_verification_token (`bool`, *isteğe bağlı*) : Metriklerin Hugging Face'in [değerlendirme servisi](https://huggingface.co/spaces/autoevaluate/model-evaluator)nden mi yoksa başka bir kaynaktan mı geldiğini doğrulamak için kullanılan bir JSON Web Token.

**Dönüş:** `dict`

Bir veri setinde değerlendirilen bir modelin sonucunu içeren bir meta veri sözlüğü.

Bir veri setinde değerlendirilen bir modelin sonucuyla bir meta veri sözlüğü oluşturur.

Örnek:
```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)
```

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

**Parametreler:**

repo_id (`str`) : Deponun adı.

metadata (`dict`) : Güncellenecek meta verileri içeren bir sözlük.

repo_type (`str`, *isteğe bağlı*) : Bir veri seti veya uzaya güncelleniyorsa `"dataset"` veya `"space"` olarak ayarlayın, bir modele güncelleniyorsa `None` veya `"model"` olarak ayarlayın. Varsayılan değer `None`'dir.

overwrite (`bool`, *isteğe bağlı*, varsayılan `False`) : `True` olarak ayarlanırsa mevcut bir alan üzerine yazılabilir, aksi halde mevcut bir alanın üzerine yazılmaya çalışılması bir hataya neden olur.

token (`str`, *isteğe bağlı*) : Hugging Face kimlik doğrulama belirteci.

commit_message (`str`, *isteğe bağlı*) : Oluşturulan commit'in özeti / başlığı / ilk satırı. Varsayılan değer `f"Update metadata with huggingface_hub"`

commit_description (`str`, *isteğe bağlı*) : Oluşturulan commit'in açıklaması

revision (`str`, *isteğe bağlı*) : Commit'in alınacağı git revizyonu. Varsayılan olarak `"main"` dalının başıdır.

create_pr (`boolean`, *isteğe bağlı*) : O commit ile `revision` üzerinden bir Pull Request oluşturulup oluşturulmayacağı. Varsayılan olarak `False`.

parent_commit (`str`, *isteğe bağlı*) : Ebeveyn commit'in OID / SHA'sı, onaltılık bir dize olarak. Kısaltmalar (ilk 7 karakter) de desteklenir. Belirtilirse ve `create_pr` `False` ise, `revision` `parent_commit`'e işaret etmiyorsa commit başarısız olur. Belirtilirse ve `create_pr` `True` ise, pull request `parent_commit`'ten oluşturulur. `parent_commit`'in belirtilmesi, değişiklikler commit edilmeden önce repoyun değişmediğinden emin olunmasını sağlar ve repo eşzamanlı olarak güncellenir / commit edilirse özellikle faydalı olabilir.

**Dönüş:** `str`

Kart meta verilerini güncelleyen commit'in URL'si.

Hugging Face Hub'daki bir depoda README.md dosyasındaki meta verileri günceller. README.md dosyası henüz yoksa, meta veriler ve varsayılan ModelCard veya DatasetCard şablonuyla yeni bir dosya oluşturulur. `space` deposu için, bir Space'in `README.md` dosyası olmadan var olamayacağı için bir hata fırlatılır.

Örnek:
```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)

```