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

توفر مكتبة huggingface_hub واجهة بلغة Python لإنشاء بطاقات النماذج/المجموعات البيانات ومشاركتها وتحديثها. يمكنك زيارة [صفحة التوثيق المخصصة](https://huggingface.co/docs/hub/models-cards) للحصول على نظرة أعمق على ما هي بطاقات النماذج على Hub وكيف تعمل في الخلفية. كما يمكنك الاطلاع على [دليل بطاقات النماذج](../how-to-model-cards) لدينا لفهم كيفية استخدام هذه الأدوات في مشاريعك الخاصة.

## بطاقة المستودع[[huggingface_hub.RepoCard]]

كائن `RepoCard` هو الفئة الأصلية لكل من [ModelCard](/docs/huggingface_hub/v2.4.0/ar/package_reference/cards#huggingface_hub.ModelCard) و[DatasetCard](/docs/huggingface_hub/v2.4.0/ar/package_reference/cards#huggingface_hub.DatasetCard) و`SpaceCard`.

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

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

[المصدر](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)
```

[المصدر](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard.py#L42)

**المعاملات:**

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

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

مثال:
```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]
> يرفع الخطأ التالي:
>
> - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) عندما لا يكون محتوى بيانات بطاقة المستودع (repo card metadata) قاموسًا.

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

[المصدر](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard.py#L289)

**المعاملات:**

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](/docs/huggingface_hub/v2.4.0/ar/package_reference/cards#huggingface_hub.RepoCard)

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

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

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

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

[المصدر](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard.py#L135)

**المعاملات:**

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](/docs/huggingface_hub/v2.4.0/ar/package_reference/cards#huggingface_hub.RepoCard)

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

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

مثال:
```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)
```

[المصدر](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard.py#L226)

**المعاملات:**

repo_id (`str`) : معرّف المستودع (repo ID) لمستودع 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`، *اختياري*) : المراجعة (revision) في 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.

#### حفظ[[huggingface_hub.RepoCard.save]]

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

[المصدر](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard.py#L115)

**المعاملات:**

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

احفظ RepoCard في ملف.

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

```

#### التحقق[[huggingface_hub.RepoCard.validate]]

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

[المصدر](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard.py#L189)

**المعاملات:**

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

يتحقق من البطاقة مقابل منطق التحقق من البطاقات الخاص بـ Hugging Face Hub. يتطلب استخدام هذه الدالة الوصول إلى الإنترنت، لذا يتم استدعاؤها داخليًا فقط بواسطة [huggingface_hub.repocard.RepoCard.push_to_hub()](/docs/huggingface_hub/v2.4.0/ar/package_reference/cards#huggingface_hub.RepoCard.push_to_hub).

> [!TIP]
> يرفع الأخطاء التالية:
>
> - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) إذا فشلت البطاقة في اختبارات التحقق. - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) إذا فشل الطلب إلى واجهة برمجة تطبيقات Hub لأي سبب آخر.

## بيانات البطاقة[[huggingface_hub.CardData]]

كائن [CardData](/docs/huggingface_hub/v2.4.0/ar/package_reference/cards#huggingface_hub.CardData) هو الفئة الأم لكل من [ModelCardData](/docs/huggingface_hub/v2.4.0/ar/package_reference/cards#huggingface_hub.ModelCardData) و [DatasetCardData](/docs/huggingface_hub/v2.4.0/ar/package_reference/cards#huggingface_hub.DatasetCardData).

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

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

[المصدر](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard_data.py#L165)

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

[CardData](/docs/huggingface_hub/v2.4.0/ar/package_reference/cards#huggingface_hub.CardData) هي الفئة الأم لكل من [ModelCardData](/docs/huggingface_hub/v2.4.0/ar/package_reference/cards#huggingface_hub.ModelCardData) و[DatasetCardData](/docs/huggingface_hub/v2.4.0/ar/package_reference/cards#huggingface_hub.DatasetCardData).

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

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

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

[المصدر](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard_data.py#L228)

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

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

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

[المصدر](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard_data.py#L233)

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

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

```python
to_dict()
```

[المصدر](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard_data.py#L178)

**يعيد:** `dict`

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

يحوّل CardData إلى dict.

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

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

[المصدر](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard_data.py#L198)

**المعاملات:**

line_break (str، *اختياري*) : سطر الفاصل المستخدم عند الإخراج إلى yaml.

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

**يعيد:** `str`

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

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

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

### بطاقة النموذج[[huggingface_hub.ModelCard]]

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

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

[المصدر](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)
```

[المصدر](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard.py#L341)

**المعاملات:**

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](/docs/huggingface_hub/v2.4.0/ar/package_reference/cards#huggingface_hub.ModelCard)

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

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

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

مثال:
```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)
```

[المصدر](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard_data.py#L271)

**المعاملات:**

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.

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 الخاص بك

مثال:
```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']}

```

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

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

### بطاقة مجموعة البيانات[[huggingface_hub.DatasetCard]]

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

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

[المصدر](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)
```

[المصدر](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard.py#L425)

**المعاملات:**

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](/docs/huggingface_hub/v2.4.0/ar/package_reference/cards#huggingface_hub.DatasetCard)

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

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

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

مثال:
```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)
```

[المصدر](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard_data.py#L400)

**المعاملات:**

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

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

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

[المصدر](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)
```

[المصدر](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard_data.py#L480)

**المعاملات:**

title (`str`، *اختياري*) : عنوان المساحة.

sdk (`str`, *اختياري*) : واجهة برمجة التطبيقات (SDK) الخاصة بالمساحة (إحدى `gradio`، `streamlit`، `docker`، أو `static`).

sdk_version (`str`، *اختياري*) : إصدار SDK المستخدم (في حال استخدام Gradio/Streamlit sdk).

python_version (`str`، *اختياري*) : إصدار بايثون المستخدم في المساحة (إذا كان Gradio/Streamlit sdk).

app_file (`str`، *اختياري*) : المسار إلى ملف التطبيق الرئيسي (الذي يحتوي إما على كود Python الخاص بـ 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.

مثال:
```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'}
```

## أدوات

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

[المصدر](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard_data.py#L13)

**المعاملات:**

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`، *اختياري*) : يُشير إلى ما إذا كانت المقاييس تنبع من [خدمة التقييم](https://huggingface.co/spaces/autoevaluate/model-evaluator) الخاصة بـ Hugging Face أم لا. يتم حسابها تلقائيًا بواسطة Hugging Face، فلا تضبطها.

verify_token (`str`، *اختياري*) : رمز ويب JSON يُستخدم للتحقق مما إذا كانت المقاييس صادرة عن [خدمة التقييم](https://huggingface.co/spaces/autoevaluate/model-evaluator) الخاصة بـ Hugging Face أم لا.

source_name (`str`، *اختياري*) : اسم مصدر نتيجة التقييم. مثال: "Open LLM Leaderboard".

source_url (`str`، *اختياري*) : عنوان URL لمصدر نتيجة التقييم. مثال: "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[[huggingface_hub.EvalResult.is_equal_except_value]]

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

[المصدر](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard_data.py#L145)

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

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

[المصدر](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard_data.py#L561)

**المعاملات:**

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

مثال:
```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)
```

[المصدر](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard_data.py#L681)

**المعاملات:**

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.

مثال:
```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)
```

[المصدر](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard.py#L560)

**المعاملات:**

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`) : يُحدد ما إذا كانت المقاييس مصدرها [خدمة التقييم](https://huggingface.co/spaces/autoevaluate/model-evaluator) لدى 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 يُستخدم للتحقق مما إذا كانت المقاييس صادرة عن [خدمة التقييم](https://huggingface.co/spaces/autoevaluate/model-evaluator) الخاصة بـ Hugging Face أم لا.

**يعيد:** `dict`

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

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

مثال:
```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)
```

[المصدر](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/repocard.py#L688)

**المعاملات:**

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`، *اختياري*) : المراجعة (revision) في 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 للالتزام الذي حدّث بيانات وصفية البطاقة.

يحدّث البيانات الوصفية في ملف README.md الخاص بمستودع على Hugging Face Hub. إذا لم يكن ملف README.md موجودًا بعد، يتم إنشاء ملف جديد يحتوي على البيانات الوصفية والقالب الافتراضي لـ ModelCard أو DatasetCard. أما في حالة مستودع `space`، فيتم طرح خطأ لأن المساحة لا يمكن أن توجد دون ملف `README.md`.

مثال:
```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)

```