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ı ziyaret edebilirsiniz. Ayrıca bu araçları kendi projelerinizde nasıl kullanacağınızı kavramak için Model Kartları kılavuzumuza göz atabilirsiniz.

Depo Kartı

RepoCard nesnesi, ModelCard, DatasetCard ve SpaceCard sınıflarının üst sınıfıdır.

sınıf huggingface_hub.RepoCard

< source >

( content: strignore_metadata_errors: bool = False )

init

< source >

( content: strignore_metadata_errors: bool = False )

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:

>>> 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] > Raises the following error: > > - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) > when the content of the repo card metadata is not a dictionary.

from_template

< source >

( card_data: CardDatatemplate_path: str | None = Nonetemplate_str: str | None = None**template_kwargs ) → huggingface_hub.repocard.RepoCard

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 giden 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üş değeri

huggingface_hub.repocard.RepoCard

Belirtilen kart verisi ve şablondan 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

< source >

( repo_id_or_path: str | pathlib.Pathrepo_type: str | None = Nonetoken: str | None = Noneignore_metadata_errors: bool = False ) → huggingface_hub.repocard.RepoCard

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ı) — Yüklenen 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 olur.
token (str, isteğe bağlı) — huggingface_hub.HfApi.login yöntemiyle alınan kimlik doğrulama jetonu. Varsayılan olarak depolanan jeton kullanılacaktı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üş değeri

huggingface_hub.repocard.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:

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

push_to_hub

< source >

Parametreler

repo_id (str) — Yüklenmesi istenen Hugging Face Hub deposunun depo kimliği. Örnek: “nateraw/food”.
token (str, isteğe bağlı) — huggingface_hub.HfApi.login yöntemiyle alınan kimlik doğrulama jetonu. Varsayılan olarak depolanan jeton kullanılacaktır.
repo_type (str, isteğe bağlı, varsayılan “model”) — Yüklenen 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ı) — Taahhüt edilecek 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.
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 repoyun eşzamanlı olarak güncellenmesi / commit edilmesi durumunda özellikle faydalı olabilir.

Dönüş değeri

str

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

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

kaydet

< source >

( filepath: pathlib.Path | str )

Parametreler

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

Bir RepoCard dosyasına kaydedin.

Örnek:

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

< source >

( repo_type: str | None = None )

Parametreler

repo_type (str, isteğe bağlı, varsayılan “model”) — Yüklenen 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 kart doğrulama mantığına göre kartı doğrular. Bu işlevin kullanılması internet erişimi gerektirdiğinden yalnızca huggingface_hub.repocard.RepoCard.push_to_hub() tarafından dahili olarak çağrılır.

Aşağıdaki hataları oluşturur:

kart doğrulama kontrollerini geçemezse ValueError.

Hub API'ye yapılan istek başka bir nedenle başarısız olursa HTTPError.

Kart Verileri

CardData nesnesi, ModelCardData ve DatasetCardData sınıflarının üst sınıfıdır.

sınıf huggingface_hub.CardData

< source >

( ignore_metadata_errors: bool = False**kwargs )

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

CardData, ModelCardData ve DatasetCardData sınıflarının üst sınıfıdır.

Metadata, sözlük veya YAML olarak dışa aktarılabilir. Verinin temsilini değiştirmek için dışa aktarma ö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

< source >

( key: strdefault: typing.Any = None )

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

pop

< source >

( key: strdefault: typing.Any = None )

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

to_dict

< source >

( ) → dict

Dönüş değeri

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

< source >

( line_break = Noneoriginal_order: list[str] | None = None ) → str

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ı) — Verildiğinde, döküm yapılmadan önce meta veri alanlarını bu listeye uygun şekilde yeniden sıralar. original_order içinde yer almayan 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üş değeri

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

sınıf huggingface_hub.ModelCard

< source >

( content: strignore_metadata_errors: bool = False )

from_template

< source >

( card_data: ModelCardDatatemplate_path: str | None = Nonetemplate_str: str | None = None**template_kwargs ) → huggingface_hub.ModelCard

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 giden 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üş değeri

huggingface_hub.ModelCard

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

Bir ModelCard'ı şablon üzerinden 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:

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

sınıf huggingface_hub.ModelCardData

< source >

Parametreler

base_model (str veya list[str], isteğe bağlı) — Modelin türetildiğ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üretiliyorsa kimliklerin listesi) olmalıdır. Varsayılan değeri None'dır.
datasets (Union[str, list[str]], isteğe bağlı) — Bu modelin eğitilmesinde 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 listesi. Verildiğinde, 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 değeri 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 değeri 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 bunun yerine license kullanın.
license_link (str, isteğe bağlı) — Bu modelin lisansına giden bağlantı. Varsayılan değeri None'dır. 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 parametresini 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 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 değeri 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.

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

Örnek:

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

sınıf huggingface_hub.DatasetCard

< source >

( content: strignore_metadata_errors: bool = False )

from_template

< source >

( card_data: DatasetCardDatatemplate_path: str | None = Nonetemplate_str: str | None = None**template_kwargs ) → huggingface_hub.DatasetCard

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 giden 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üş değeri

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:

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

sınıf huggingface_hub.DatasetCardData

< source >

Parametreler

language (list[str], isteğe bağlı) — Veri setinin 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.
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ğunu belirtir. 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 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

sınıf huggingface_hub.SpaceCard

< source >

( content: strignore_metadata_errors: bool = False )

SpaceCardData

sınıf huggingface_hub.SpaceCardData

< source >

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çerir). Yol, deposunun kök dizinine 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 ilişkili 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ı) — Alan 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:

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

sınıf huggingface_hub.EvalResult

< source >

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örevin 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() çağrısı 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() çağrısı 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 hizmetinden 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 servisinden mi yoksa başka bir kaynaktan mı 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

< source >

( other: EvalResult )

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

< source >

( model_index: list ) → model_name (str)

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üş değeri

model_name (str)

Model indeksi içinde 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:

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

< source >

( model_name: streval_results: list ) → model_index (list[dict[str, Any]])

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üş değeri

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:

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

< source >

( model_pretty_name: strtask_pretty_name: strtask_id: strmetrics_pretty_name: strmetrics_id: strmetrics_value: typing.Anydataset_pretty_name: strdataset_id: strmetrics_config: str | None = Nonemetrics_verified: bool = Falsedataset_config: str | None = Nonedataset_split: str | None = Nonedataset_revision: str | None = Nonemetrics_verification_token: str | None = None ) → dict

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 seti 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 değerlendirme hizmetinden 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 servisinden mi yoksa başka bir kaynaktan mı geldiğini doğrulamak için kullanılan bir JSON Web Token'dır.

Dönüş değeri

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:

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

< source >

Parametreler

repo_id (str) — Deponun adı.
metadata (dict) — Güncellenecek metadata'ı içeren bir sözlük.
repo_type (str, isteğe bağlı) — Bir veri seti veya space güncellemesi yapılıyorsa "dataset" veya "space" olarak ayarlayın, bir model güncellemesi yapılıyorsa 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 değer False'tur.
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 repoyun eşzamanlı olarak güncellenmesi / commit edilmesi durumunda özellikle faydalı olabilir.

Dönüş değeri

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:

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

Update on GitHub

Hub Python Library

Depo Kartları

Depo Kartı

sınıf huggingface_hub.RepoCard

__init__

from_template

load

push_to_hub

kaydet

doğrula

Kart Verileri

sınıf huggingface_hub.CardData

get

pop

to_dict

to_yaml

Model Kartları

ModelCard

sınıf huggingface_hub.ModelCard

from_template

ModelCardData

sınıf huggingface_hub.ModelCardData

Veri Seti Kartları

DatasetCard

sınıf huggingface_hub.DatasetCard

from_template

DatasetCardData

sınıf huggingface_hub.DatasetCardData

Space Kartları

SpaceCard

sınıf huggingface_hub.SpaceCard

SpaceCardData

sınıf huggingface_hub.SpaceCardData

Yardımcılar

EvalResult

sınıf huggingface_hub.EvalResult

is_equal_except_value

model_index_to_eval_results

huggingface_hub.repocard_data.model_index_to_eval_results

eval_results_to_model_index

huggingface_hub.repocard_data.eval_results_to_model_index

metadata_eval_result

huggingface_hub.metadata_eval_result

metadata_update

huggingface_hub.metadata_update

init