Hub Python Library documentation

بطاقات المستودعات

Hub Python Library

Join the Hugging Face community

and get access to the augmented documentation experience

Collaborate on models, datasets and Spaces

Faster examples with accelerated inference

Switch between documentation themes

to get started

بطاقات المستودعات

توفر مكتبة huggingface_hub واجهة بلغة Python لإنشاء بطاقات النماذج/المجموعات البيانات ومشاركتها وتحديثها. قم بزيارة الصفحة المخصصة للتوثيق للحصول على نظرة أعمق على ما هي بطاقات النماذج على Hub وكيف تعمل في الخلفية. كما يمكنك الاطلاع على دليل بطاقات النماذج لدينا للحصول على فكرة عن كيفية استخدام هذه الأدوات في مشاريعك الخاصة.

بطاقة المستودع

كائن RepoCard هو الفئة الأصلية لكل من ModelCard وDatasetCard وSpaceCard.

فئة huggingface_hub.RepoCard

( content: strignore_metadata_errors: bool = False )

init

( content: strignore_metadata_errors: bool = False )

المعاملات

content (str) — محتوى ملف Markdown.

تهيئة كائن RepoCard من محتوى نصي. يجب أن يكون الملف بصيغة Markdown ويحتوي على كتلة YAML في البداية وجسم نصي بصيغة Markdown.

مثال:

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

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

المعاملات

card_data (huggingface_hub.CardData) — مثال على huggingface_hub.CardData يحتوي على البيانات الوصفية التي تريد تضمينها في ترويسة YAML لبطاقة المستودع على Hugging Face Hub.
template_path (str, اختياري) — مسار إلى ملف Markdown يحتوي على متغيرات قالب Jinja اختيارية يمكن تعبئتها باستخدام template_kwargs. القيمة الافتراضية هي القالب الافتراضي.
template_str (str, اختياري) — نص قالب Jinja خام مع متغيرات اختيارية. يُستخدم عندما لا يكون template_path أو القالب الافتراضي مناسبين. يتم تجاهله إذا تم تقديم template_path أيضًا.

يعيد

huggingface_hub.repocard.RepoCard

مثال من نوع RepoCard يحتوي على بيانات البطاقة والمحتوى المحدد من القالب.

Initialize بطاقة مستودع من قالب. افتراضيًا، يستخدم القالب الافتراضي.

القوالب هي قوالب Jinja2 يمكن تخصيصها عن طريق تمرير معاملات بكلمات مفتاحية.

load

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

المعاملات

repo_id_or_path (Union[str, Path]) — معرّف المستودع المرتبط بمستودع Hugging Face Hub أو مسار ملف محلي.
repo_type (str, اختياري) — نوع مستودع Hugging Face الذي سيتم الدفع إليه. القيمة الافتراضية هي None، والتي ستستخدم “model”. الخيارات الأخرى هي “dataset” و “space”. لا يُستخدم عند التحميل من مسار ملف محلي. إذا تم استدعاؤه من فئة فرعية، فستكون القيمة الافتراضية هي repo_type للفئة الفرعية.
token (str، اختياري) — رمز المصادقة، الذي يُستحصل عليه عبر طريقة huggingface_hub.HfApi.login. سيُستخدم الرمز المخزَّن افتراضيًا.
ignore_metadata_errors (str) — إذا كانت القيمة True، سيتم تجاهل الأخطاء التي تحدث أثناء تحليل قسم البيانات الوصفية. قد تُفقد بعض المعلومات خلال هذه العملية. استخدمها على مسؤوليتك الخاصة.

يعيد

huggingface_hub.repocard.RepoCard

RepoCard (أو فئة فرعية منها) تم تهيئتها من ملف README.md الخاص بالمستودع أو من مسار الملف.

Initialize كائن RepoCard من ملف README.md الخاص بمستودع على Hugging Face Hub أو من مسار ملف محلي.

مثال:

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

push_to_hub

( repo_id: strtoken: str | None = Nonerepo_type: str | None = Nonecommit_message: str | None = Nonecommit_description: str | None = Nonerevision: str | None = Nonecreate_pr: bool | None = Noneparent_commit: str | None = None ) → str

المعاملات

repo_id (str) — معرّف المستودع الخاص بمستودع Hugging Face Hub الذي سيتم الدفع إليه. مثال: “nateraw/food”.
token (str، اختياري) — رمز المصادقة، الذي يُستحصل عليه عبر طريقة huggingface_hub.HfApi.login. سيُستخدم الرمز المخزَّن افتراضيًا.
repo_type (str، اختياري، الافتراضي “model”) — نوع مستودع Hugging Face الذي سيتم الدفع إليه. الخيارات هي “model” و”dataset” و”space”. إذا تم استدعاء هذه الدالة بواسطة فئة فرعية، فسيكون الافتراضي هو repo_type الخاص بالفئة الفرعية.
commit_message (str، اختياري) — ملخص/عنوان/السطر الأول للالتزام المولّد.
commit_description (str، اختياري) — وصف الالتزام المُولَّد.
revision (str، اختياري) — مراجعة git التي سيتم الالتزام منها. الافتراضي هو رأس فرع "main".
create_pr (bool، اختياري) — ما إذا كان سيتم إنشاء طلب سحب (Pull Request) بهذا الالتزام أم لا. القيمة الافتراضية هي False.
parent_commit (str, اختياري) — معرّف OID / SHA للالتزام الأب، كنص سداسي عشري. يتم دعم الاختصارات (الأحرف السبعة الأولى) أيضًا. إذا تم تحديده وكان create_pr هو False، فسيفشل الالتزام إذا لم يشير revision إلى parent_commit. إذا تم تحديده وكان create_pr هو True، فسيتم إنشاء طلب السحب من parent_commit. يضمن تحديد parent_commit عدم تغيير المستودع قبل الالتزام بالتغييرات، ويمكن أن يكون مفيدًا بشكل خاص إذا تم تحديث المستودع / الالتزام به بشكل متزامن.

يعيد

str

عنوان URL للالتزام الذي حدّث بيانات وصفية البطاقة.

ادفع بطاقة مستودع إلى مستودع في Hugging Face Hub.

حفظ

( filepath: pathlib.Path | str )

المعاملات

filepath (Union[Path, str]) — مسار الملف إلى ملف Markdown الذي سيتم حفظه.

احفظ RepoCard في ملف.

مثال:

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

validate

( repo_type: str | None = None )

المعاملات

repo_type (str، اختياري، الافتراضي “model”) — نوع مستودع Hugging Face الذي سيتم الدفع إليه. الخيارات هي “model” و “dataset” و “space”. إذا تم استدعاء هذه الدالة من فئة فرعية، فإن القيمة الافتراضية ستكون repo_type الخاصة بالفئة الفرعية.

يتحقق من البطاقة مقابل منطق التحقق من البطاقات الخاص بـ Hugging Face Hub. يتطلب استخدام هذه الدالة الوصول إلى الإنترنت، لذا يتم استدعاؤها داخليًا فقط بواسطة huggingface_hub.repocard.RepoCard.push_to_hub().

يرفع الأخطاء التالية:

ValueError إذا فشلت البطاقة في اختبارات التحقق.

HTTPError إذا فشل الطلب إلى واجهة برمجة تطبيقات Hub لأي سبب آخر.

بيانات البطاقة

كائن CardData هو الفئة الأم لكل من ModelCardData و DatasetCardData.

فئة huggingface_hub.CardData

( ignore_metadata_errors: bool = False**kwargs )

هيكل يحتوي على بيانات وصفية من بطاقة المستودع.

CardData هي الفئة الأم لكل من ModelCardData وDatasetCardData.

يمكن تصدير البيانات الوصفية كقاموس أو بصيغة YAML. ويمكن تخصيص عملية التصدير لتغيير تمثيل البيانات (مثال: تسطيح نتائج التقييم). يتصرف CardData كقاموس (يمكنه الجلب، والحذف، وإعداد القيم) لكنه لا يرث من dict للسماح بهذه خطوة التصدير.

get

( key: strdefault: typing.Any = None )

احصل على القيمة لمفتاح بيانات وصفية معيّن.

pop

( key: strdefault: typing.Any = None )

قيمة Pop لمفتاح بيانات وصفية محدد.

to_dict

( ) → dict

يعيد

dict

بيانات CardData ممثلة كقاموس جاهز للتحويل إلى كتلة YAML للإدراج في ملف README.md.

يحوّل CardData إلى dict.

to_yaml

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

المعاملات

line_break (str، اختياري) — سطر الفاصل المستخدم عند الإخراج إلى yaml.
original_order (list[str]، اختياري) — إذا تم تقديمه، يُعاد ترتيب حقول البيانات الوصفية لتتطابق مع هذه القائمة قبل الإخراج. تُضاف أي مفاتيح غير موجودة في original_order بعد المفاتيح المدرجة، مع الحفاظ على ترتيبها النسبي الحالي. مفيد لإعادة تمرير كتلة YAML دون خلط مفاتيحها.

يعيد

str

بيانات بطاقة CardData ممثلة على شكل كتلة YAML.

تُخرج بيانات CardData إلى كتلة YAML لتضمينها في ملف README.md.

بطاقات النماذج

بطاقة النموذج

فئة huggingface_hub.ModelCard

( content: strignore_metadata_errors: bool = False )

from_template

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

المعاملات

card_data (huggingface_hub.ModelCardData) — مثال على huggingface_hub.ModelCardData يحتوي على البيانات الوصفية التي تريد تضمينها في ترويسة YAML لبطاقة النموذج على Hugging Face Hub.
template_path (str, اختياري) — مسار إلى ملف Markdown يحتوي على متغيرات قالب Jinja اختيارية يمكن تعبئتها باستخدام template_kwargs. القيمة الافتراضية هي القالب الافتراضي.
template_str (str, اختياري) — نص قالب Jinja خام مع متغيرات اختيارية. يُستخدم عندما لا يكون template_path أو القالب الافتراضي مناسبين. يتم تجاهله إذا تم تقديم template_path أيضًا.

يعيد

huggingface_hub.ModelCard

مثال من فئة ModelCard يحتوي على بيانات البطاقة والمحتوى المحدد من القالب.

تهيئة بطاقة نموذج (ModelCard) من قالب. افتراضيًا، يستخدم القالب الافتراضي، والذي يمكن العثور عليه هنا: https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md

القوالب هي قوالب Jinja2 يمكن تخصيصها عن طريق تمرير معاملات بكلمات مفتاحية.

مثال:

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

( base_model: str | list[str] | None = Nonedatasets: str | list[str] | None = Noneeval_results: list[huggingface_hub.repocard_data.EvalResult] | None = Nonelanguage: str | list[str] | None = Nonelibrary_name: str | None = Nonelicense: str | None = Nonelicense_name: str | None = Nonelicense_link: str | None = Nonemetrics: list[str] | None = Nonemodel_name: str | None = Nonepipeline_tag: str | None = Nonetags: list[str] | None = Noneignore_metadata_errors: bool = False**kwargs )

المعاملات

base_model (str أو list[str]، اختياري) — المعرّف للنموذج الأساسي الذي اشتُق منه النموذج. ينطبق هذا على سبيل المثال إذا كان نموذجك هو نسخة مُحسَّنة (fine-tune) أو مُكيِّف (adapter) لنموذج موجود مسبقًا. يجب أن تكون القيمة هي معرّف نموذج على Hub (أو قائمة من المعرّفات إذا اشتُق نموذجك من عدة نماذج). القيمة الافتراضية هي None.
datasets (Union[str, list[str]]، اختياري) — مجموعة بيانات أو قائمة بمجموعات البيانات التي استُخدمت لتدريب هذا النموذج. يجب أن يكون معرّف مجموعة بيانات موجودة على https://hf.co/datasets. القيمة الافتراضية هي None.
eval_results (Union[list[EvalResult], EvalResult]، اختياري) — قائمة من huggingface_hub.EvalResult تُعرّف نتائج تقييم النموذج. إذا تم تقديمها، يُستخدم model_name كاسم في لوحات الصدارة الخاصة بـ PapersWithCode. القيمة الافتراضية هي None.
language (Union[str, list[str]], اختياري) — لغة بيانات التدريب أو البيانات الوصفية للنموذج. يجب أن يكون رمز ISO 639-1 أو 639-2 أو 639-3 (حرفان/ثلاثة أحرف)، أو قيمة خاصة مثل “code” أو “multilingual”. القيمة الافتراضية هي None.
library_name (str، اختياري) — اسم المكتبة المستخدمة بواسطة هذا النموذج. مثال: keras أو أي مكتبة من https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/model-libraries.ts. الافتراضي هو None.
license (str, اختياري) — رخصة هذا النموذج. مثال: apache-2.0 أو أي رخصة من https://huggingface.co/docs/hub/repositories-licenses. القيمة الافتراضية هي None.
license_name (str, optional) — Name of the license of this model. Defaults to None. To be used in conjunction with license_link. Common licenses (Apache-2.0, MIT, CC-BY-SA-4.0) do not need a name. In that case, use license instead.
license_link (str, optional) — Link to the license of this model. Defaults to None. To be used in conjunction with license_name. Common licenses (Apache-2.0, MIT, CC-BY-SA-4.0) do not need a link. In that case, use license instead.
metrics (list[str]، اختياري) — قائمة بالمقاييس المستخدمة لتقييم هذا النموذج. يجب أن يكون اسم مقياس يمكن العثور عليه في https://hf.co/metrics. مثال: ‘accuracy’. القيمة الافتراضية هي None.
model_name (str, اختياري) — اسم لهذا النموذج. يُستخدم مع eval_results لبناء model-index ضمن بيانات الوصف الخاصة بالبطاقة. الاسم الذي توفّره هنا هو ما سيُستخدم في لوحات الصدارة الخاصة بـ PapersWithCode. إذا تم تقديم None، فسيُستخدم اسم المستودع كقيمة افتراضية. القيمة الافتراضية هي None.
pipeline_tag (str، اختياري) — وسم الخطّ الأنابيب المرتبط بالنموذج. مثال: “text-classification”.
tags (list[str]، اختياري) — قائمة بالوسوم التي تُضاف إلى نموذجك ويمكن استخدامها عند التصفية على Hugging Face Hub. القيمة الافتراضية هي None.
ignore_metadata_errors (str) — إذا كانت القيمة True، سيتم تجاهل الأخطاء التي تحدث أثناء تحليل قسم البيانات الوصفية. قد تُفقد بعض المعلومات خلال هذه العملية. استخدمها على مسؤوليتك الخاصة.
kwargs (dict، اختياري) — بيانات وصفية إضافية ستُضاف إلى بطاقة النموذج. القيمة الافتراضية هي None.

بيانات وصفية لبطاقة النموذج تُستخدمها Hugging Face Hub عند تضمينها في أعلى ملف README.md الخاص بك

مثال:

>>> 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']}

بطاقات مجموعات البيانات

تُعرف بطاقات مجموعات البيانات أيضًا باسم بطاقات البيانات في مجتمع تعلم الآلة.

بطاقة مجموعة البيانات

فئة huggingface_hub.DatasetCard

( content: strignore_metadata_errors: bool = False )

from_template

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

المعاملات

card_data (huggingface_hub.DatasetCardData) — مثال على huggingface_hub.DatasetCardData يحتوي على البيانات الوصفية التي تريد تضمينها في ترويسة YAML لبطاقة مجموعة البيانات على Hugging Face Hub.
template_path (str, اختياري) — مسار إلى ملف Markdown يحتوي على متغيرات قالب Jinja اختيارية يمكن تعبئتها باستخدام template_kwargs. القيمة الافتراضية هي القالب الافتراضي.
template_str (str, اختياري) — نص قالب Jinja خام مع متغيرات اختيارية. يُستخدم عندما لا يكون template_path أو القالب الافتراضي مناسبين. يتم تجاهله إذا تم تقديم template_path أيضًا.

يعيد

huggingface_hub.DatasetCard

مثال من DatasetCard يحتوي على بيانات البطاقة والمحتوى المحدد من القالب.

تُهيّئ بطاقة مجموعة بيانات (DatasetCard) من قالب. افتراضيًا، يستخدم القالب الافتراضي، والذي يمكن العثور عليه هنا: https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md

القوالب هي قوالب Jinja2 يمكن تخصيصها عن طريق تمرير معاملات بكلمات مفتاحية.

مثال:

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

( language: str | list[str] | None = Nonelicense: str | list[str] | None = Noneannotations_creators: str | list[str] | None = Nonelanguage_creators: str | list[str] | None = Nonemultilinguality: str | list[str] | None = Nonesize_categories: str | list[str] | None = Nonesource_datasets: list[str] | None = Nonetask_categories: str | list[str] | None = Nonetask_ids: str | list[str] | None = Nonepaperswithcode_id: str | None = Nonepretty_name: str | None = Nonetrain_eval_index: dict | None = Noneconfig_names: str | list[str] | None = Noneignore_metadata_errors: bool = False**kwargs )

المعاملات

language (list[str]، اختياري) — لغة بيانات المجموعة أو بياناتها الوصفية. يجب أن يكون رمز ISO 639-1 أو 639-2 أو 639-3 (حرفان/ثلاثة أحرف)، أو قيمة خاصة مثل “code” أو “multilingual”.
license (Union[str, list[str]]، اختياري) — رخصة أو رخص هذا مجموعة البيانات. مثال: apache-2.0 أو أي رخصة من https://huggingface.co/docs/hub/repositories-licenses.
annotations_creators (Union[str, list[str]]، اختياري) — كيف تم إنشاء التعليقات التوضيحية للمجموعة. الخيارات هي: ‘found’، ‘crowdsourced’، ‘expert-generated’، ‘machine-generated’، ‘no-annotation’، ‘other’.
language_creators (Union[str, list[str]]، اختياري) — كيف تم إنشاء البيانات النصية في مجموعة البيانات. الخيارات هي: ‘found’، ‘crowdsourced’، ‘expert-generated’، ‘machine-generated’، ‘other’
multilinguality (Union[str, list[str]]، اختياري) — ما إذا كانت مجموعة البيانات متعددة اللغات. الخيارات هي: ‘monolingual’، ‘multilingual’، ‘translation’، ‘other’.
size_categories (Union[str, list[str]]، اختياري) — عدد الأمثلة في مجموعة البيانات. الخيارات هي: ‘n<1K’، ‘1K1T’، و‘other’.
source_datasets (list[str]]، اختياري) — يحدد ما إذا كان مجموعة البيانات أصلية أو ممتدة من مجموعة بيانات أخرى موجودة مسبقًا. الخيارات هي: ‘original’ و ‘extended’.
task_categories (Union[str, list[str]]، اختياري) — ما هي فئات المهام التي يدعمها مجموعة البيانات؟
task_ids (Union[str, list[str]]، اختياري) — ما هي المهام المحددة التي يدعمها مجموعة البيانات؟
paperswithcode_id (str، اختياري) — معرّف مجموعة البيانات على PapersWithCode.
pretty_name (str، اختياري) — اسم أكثر قابلية للقراءة البشرية للمجموعة. (مثال: “القطط مقابل الكلاب”)
train_eval_index (dict, اختياري) — قاموس يصف المواصفات اللازمة لإجراء التقييم على Hub. إذا لم يُقدَّم، فسيتم جمعه من المفتاح ‘train-eval-index’ في kwargs.
config_names (Union[str, list[str]]، اختياري) — قائمة بتكوينات البيانات المتاحة لهذا مجموعة البيانات.

بيانات الوصف الخاصة ببطاقة مجموعة البيانات التي يستخدمها Hugging Face Hub عند تضمينها في أعلى ملف README.md الخاص بك

بطاقات الفضاء

SpaceCard

فئة huggingface_hub.SpaceCard

( content: strignore_metadata_errors: bool = False )

SpaceCardData

فئة huggingface_hub.SpaceCardData

( title: str | None = Nonesdk: str | None = Nonesdk_version: str | None = Nonepython_version: str | None = Noneapp_file: str | None = Noneapp_port: int | None = Nonelicense: str | None = Noneduplicated_from: str | None = Nonemodels: list[str] | None = Nonedatasets: list[str] | None = Nonetags: list[str] | None = Noneignore_metadata_errors: bool = False**kwargs )

المعاملات

title (str، اختياري) — عنوان المساحة.
sdk (str، اختياري) — SDK الخاص بالمساحة (إحدى gradio، streamlit، docker، أو static).
sdk_version (str، اختياري) — إصدار SDK المستخدم (في حال كان Gradio/Streamlit sdk).
python_version (str، اختياري) — إصدار Python المستخدم في المساحة (في حال استخدام Gradio/Streamlit sdk).
app_file (str, اختياري) — المسار إلى ملف التطبيق الرئيسي (الذي يحتوي إما على كود بايثون الخاص بـ gradio أو streamlit، أو كود html ثابت). المسار نسبي بالنسبة لجذر المستودع.
app_port (str، اختياري) — المنفذ الذي يعمل عليه تطبيقك. يُستخدم فقط إذا كان sdk هو docker.
license (str، اختياري) — رخصة هذا النموذج. مثال: apache-2.0 أو أي رخصة من https://huggingface.co/docs/hub/repositories-licenses.
duplicated_from (str، اختياري) — معرّف المساحة الأصلية إذا كانت هذه مساحة مكررة.
models (list[str]، اختياري) — قائمة بالنماذج المرتبطة بهذا الفضاء. يجب أن يكون معرّف مجموعة بيانات موجود على https://hf.co/models.
datasets (list[str]، اختياري) — قائمة بمجموعات البيانات المرتبطة بهذا المساحة. يجب أن يكون معرّف مجموعة بيانات موجود على https://hf.co/datasets.
tags (list[str]، اختياري) — قائمة من الوسوم التي تُضاف إلى مساحتك ويمكن استخدامها عند التصفية على Hub.
ignore_metadata_errors (str) — إذا كانت القيمة True، سيتم تجاهل الأخطاء التي تحدث أثناء تحليل قسم البيانات الوصفية. قد تُفقد بعض المعلومات خلال هذه العملية. استخدمها على مسؤوليتك الخاصة.
kwargs (dict، اختياري) — بيانات وصفية إضافية ستُضاف إلى بطاقة المساحة.

بيانات الوصف (Metadata) الخاصة ببطاقة الفضاء (Space Card) التي يستخدمها Hugging Face Hub عند تضمينها في أعلى ملف README.md الخاص بك

للحصول على مرجع شامل لإعدادات Spaces، يرجى زيارة https://huggingface.co/docs/hub/spaces-config-reference#spaces-configuration-reference.

مثال:

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

أدوات

EvalResult

فئة huggingface_hub.EvalResult

( task_type: strdataset_type: strdataset_name: strmetric_type: strmetric_value: typing.Anytask_name: str | None = Nonedataset_config: str | None = Nonedataset_split: str | None = Nonedataset_revision: str | None = Nonedataset_args: dict[str, typing.Any] | None = Nonemetric_name: str | None = Nonemetric_config: str | None = Nonemetric_args: dict[str, typing.Any] | None = Noneverified: bool | None = Noneverify_token: str | None = Nonesource_name: str | None = Nonesource_url: str | None = None )

المعاملات

task_type (str) — معرّف المهمة. مثال: “image-classification”.
dataset_type (str) — معرّف مجموعة البيانات. مثال: “common_voice”. استخدم معرّف المجموعة من https://hf.co/datasets.
dataset_name (str) — اسم جميل للمجموعة. مثال: “Common Voice (French)“.
metric_type (str) — معرّف المقياس. مثال: “wer”. استخدم معرّف المقياس من https://hf.co/metrics.
metric_value (Any) — قيمة المقياس. مثال: 0.9 أو “20.0 ± 1.2”.
task_name (str، اختياري) — اسم جميل للمهمة. مثال: “Speech Recognition”.
dataset_config (str, اختياري) — اسم إعداد مجموعة البيانات المستخدم في load_dataset(). مثال: fr في load_dataset("common_voice", "fr"). راجع وثائق datasets لمزيد من المعلومات: https://hf.co/docs/datasets/package_reference/loading_methods#datasets.load_dataset.name
dataset_split (str، اختياري) — الجزء المستخدم في load_dataset(). مثال: “test”.
dataset_revision (str, اختياري) — المراجعة (المعروفة أيضًا باسم Git Sha) للمجموعة البيانات المستخدمة في load_dataset(). مثال: 5503434ddd753f426f4b38109466949a1217c2bb
dataset_args (dict[str, Any]، اختياري) — الحجج المُمررة أثناء Metric.compute(). مثال على bleu: {"max_order": 4}
metric_name (str، اختياري) — اسم جميل للمقياس. مثال: “Test WER”.
metric_config (str، اختياري) — اسم إعداد المقياس المستخدم في load_metric(). مثال: bleurt-large-512 في load_metric("bleurt", "bleurt-large-512"). راجع وثائق datasets لمزيد من المعلومات: https://huggingface.co/docs/datasets/v2.1.0/en/loading#load-configurations
metric_args (dict[str, Any]، اختياري) — الحجج المُمررة أثناء Metric.compute(). مثال على bleu: max_order: 4
verified (bool، اختياري) — يشير إلى ما إذا كانت المقاييس تنبع من خدمة التقييم الخاصة بـ Hugging Face أم لا. يتم حسابها تلقائيًا بواسطة Hugging Face، فلا تضبطها.
verify_token (str، اختياري) — رمز ويب JSON يُستخدم للتحقق مما إذا كانت المقاييس صادرة عن خدمة التقييم الخاصة بـ Hugging Face أم لا.
source_name (str، اختياري) — اسم مصدر نتيجة التقييم. مثال: “Open LLM Leaderboard”.
source_url (str، اختياري) — رابط مصدر نتيجة التقييم. مثال: ”https://huggingface.co/spaces/open-llm-leaderboard/open_llm_leaderboard”.

تمثيل مسطّح لنتائج التقييم الفردية الموجودة في فهرس النموذج (model-index) من بطاقات النموذج (Model Cards).

لمزيد من المعلومات حول مواصفات model-index، راجع https://github.com/huggingface/hub-docs/blob/main/modelcard.md?plain=1.

is_equal_except_value

( other: EvalResult )

تُرجع True إذا كان self وother يصفان نفس المقياس تمامًا لكن بقيم مختلفة.

model_index_to_eval_results

huggingface_hub.repocard_data.model_index_to_eval_results

( model_index: list ) → model_name (str)

المعاملات

model_index (list[dict[str, Any]]) — هيكل بيانات فهرس النموذج، غالبًا ما يأتي من ملف README.md على Hugging Face Hub.

يعيد

model_name (str)

اسم النموذج كما هو موجود في فهرس النموذج. يُستخدم هذا الاسم كمعرّف للنموذج في لوحات الصدارة مثل PapersWithCode. eval_results (list[EvalResult]): قائمة من كائنات huggingface_hub.EvalResult تحتوي على المقاييس المُبلَّغ عنها في model_index المُقدَّم.

يستقبل فهرس نموذج ويعيد اسم النموذج وقائمة من كائنات huggingface_hub.EvalResult.

يمكن العثور على مواصفات تفصيلية لمؤشر النموذج هنا: https://github.com/huggingface/hub-docs/blob/main/modelcard.md?plain=1

مثال:

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

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

المعاملات

model_name (str) — اسم النموذج (مثلًا “my-cool-model”). يُستخدم هذا الاسم كمعرّف للنموذج في لوحات الترتيب مثل PapersWithCode.
eval_results (list[EvalResult]) — قائمة من كائنات huggingface_hub.EvalResult تحتوي على المقاييس التي سيتم الإبلاغ عنها في فهرس النموذج.

يعيد

model_index (list[dict[str, Any]])

تم تحويل eval_results إلى model-index.

يستقبل اسم النموذج المحدد وقائمة من huggingface_hub.EvalResult ويعيد فهرس نموذج صالحًا متوافقًا مع التنسيق المتوقع من Hugging Face Hub.

مثال:

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

( 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

المعاملات

model_pretty_name (str) — اسم النموذج باللغة الطبيعية.
task_pretty_name (str) — اسم المهمة بلغة طبيعية.
task_id (str) — مثال: automatic-speech-recognition. معرّف مهمة.
metrics_pretty_name (str) — اسم للمقياس بلغة طبيعية. مثال: Test WER.
metrics_id (str) — مثال: wer. معرّف مقياس من https://hf.co/metrics.
metrics_value (Any) — القيمة المستخرجة من المقياس. مثال: 20.0 أو “20.0 ± 1.2”.
dataset_pretty_name (str) — اسم مجموعة البيانات باللغة الطبيعية.
dataset_id (str) — مثال: common_voice. معرّف مجموعة بيانات من https://hf.co/datasets.
metrics_config (str، اختياري) — اسم إعداد المقياس المستخدم في load_metric(). مثال: bleurt-large-512 في load_metric("bleurt", "bleurt-large-512").
metrics_verified (bool، اختياري، القيمة الافتراضية False) — يشير إلى ما إذا كانت المقاييس تنبع من خدمة التقييم الخاصة بـ Hugging Face أم لا. يتم حسابها تلقائيًا بواسطة Hugging Face، فلا تضبطها.
dataset_config (str، اختياري) — مثال: fr. اسم تكوين مجموعة البيانات المستخدم في load_dataset().
dataset_split (str، اختياري) — مثال: test. اسم الجزء من مجموعة البيانات المستخدم في load_dataset().
dataset_revision (str, اختياري) — مثال: 5503434ddd753f426f4b38109466949a1217c2bb. اسم مراجعة مجموعة البيانات المستخدمة في load_dataset().
metrics_verification_token (bool، اختياري) — رمز ويب JSON يُستخدم للتحقق مما إذا كانت المقاييس صادرة عن خدمة التقييم الخاصة بـ Hugging Face أم لا.

يعيد

dict

قواميس بيانات وصفية تحتوي على نتيجة نموذج تم تقييمه على مجموعة بيانات.

ينشئ قاموس بيانات وصفية يحتوي على نتيجة نموذج تم تقييمه على مجموعة بيانات.

مثال:

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

( repo_id: strmetadata: dictrepo_type: str | None = Noneoverwrite: bool = Falsetoken: str | None = Nonecommit_message: str | None = Nonecommit_description: str | None = Nonerevision: str | None = Nonecreate_pr: bool = Falseparent_commit: str | None = None ) → str

المعاملات

repo_id (str) — اسم المستودع.
metadata (dict) — قاموس يحتوي على البيانات الوصفية التي سيتم تحديثها.
repo_type (str، اختياري) — اضبطه على "dataset" أو "space" عند التحديث إلى مجموعة بيانات أو مساحة، أو None أو "model" عند التحديث إلى نموذج. القيمة الافتراضية هي None.
overwrite (bool، اختياري، القيمة الافتراضية False) — إذا تم ضبطه على True، يمكن تجاوز الحقل الموجود مسبقًا، وإلا فإن محاولة تجاوز الحقل الموجود ستسبب خطأ.
token (str، اختياري) — رمز المصادقة الخاص بـ Hugging Face.
commit_message (str، اختياري) — ملخص / عنوان / السطر الأول للالتزام المولّد. القيمة الافتراضية هي f"Update metadata with huggingface_hub"
commit_description (str، اختياري) — وصف الالتزام المُولَّد
revision (str، اختياري) — مراجعة git التي سيتم الالتزام منها. الافتراضي هو رأس فرع "main".
create_pr (boolean، اختياري) — ما إذا كان سيتم إنشاء طلب سحب (Pull Request) من revision مع ذلك الالتزام. الافتراضي هو False.
parent_commit (str, اختياري) — معرّف OID / SHA للالتزام الأب، كنص سداسي عشري. يتم دعم الاختصارات (الأحرف السبعة الأولى) أيضًا. إذا تم تحديده وكان create_pr هو False، فسيفشل الالتزام إذا لم يشير revision إلى parent_commit. إذا تم تحديده وكان create_pr هو True، فسيتم إنشاء طلب السحب من parent_commit. يضمن تحديد parent_commit عدم تغيير المستودع قبل الالتزام بالتغييرات، ويمكن أن يكون مفيدًا بشكل خاص إذا تم تحديث المستودع / الالتزام به بشكل متزامن.

يعيد

str

عنوان URL للالتزام الذي حدّث بيانات وصفية البطاقة.

Updates the metadata in the README.md of a repository on the Hugging Face Hub. If the README.md file doesn’t exist yet, a new one is created with metadata and the default ModelCard or DatasetCard template. For space repo, an error is thrown as a Space cannot exist without a README.md file.

مثال:

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

←مرجع نظام التخزين المؤقت بيئة تشغيل Space→