Hugging Face 的 LOGO

Hub Python 庫文件

建立和分享模型卡

Hugging Face's logo
加入 Hugging Face 社群

並獲得增強的文件體驗

開始使用

建立和分享模型卡

huggingface_hub 庫提供了一個 Python 介面來建立、分享和更新模型卡。訪問 專門的文件頁面，以更深入地瞭解 Hub 上的模型卡是什麼以及它們如何工作。

從 Hub 載入模型卡

要從 Hub 載入現有的卡片，您可以使用 ModelCard.load() 函式。在這裡，我們將載入 nateraw/vit-base-beans 的卡片。

from huggingface_hub import ModelCard

card = ModelCard.load('nateraw/vit-base-beans')

這張卡片有一些有用的屬性，您可能想要訪問/利用它們

  • card.data：返回一個 ModelCardData 例項，其中包含模型卡的元資料。呼叫此例項上的 .to_dict() 以獲取字典表示形式。
  • card.text：返回卡片的文字，不包括元資料頭部。
  • card.content：返回卡片的文字內容，包括元資料頭部。

建立模型卡

從文字建立

要從文字初始化模型卡，只需將卡片的文字內容傳遞給初始化時的 ModelCard。

content = """
---
language: en
license: mit
---

# My Model Card
"""

card = ModelCard(content)
card.data.to_dict() == {'language': 'en', 'license': 'mit'}  # True

另一種方法是使用 f-string。在以下示例中，我們

  • 使用 ModelCardData.to_yaml() 將我們定義的元資料轉換為 YAML，以便我們可以使用它來在模型卡中插入 YAML 塊。
  • 展示如何透過 Python f-string 使用模板變數。
card_data = ModelCardData(language='en', license='mit', library='timm')

example_template_var = 'nateraw'
content = f"""
---
{ card_data.to_yaml() }
---

# My Model Card

This model created by [@{example_template_var}](https://github.com/{example_template_var})
"""

card = ModelCard(content)
print(card)

上面的例子將得到一張如下所示的卡片

---
language: en
license: mit
library: timm
---

# My Model Card

This model created by [@nateraw](https://github.com/nateraw)

從 Jinja 模板建立

如果您安裝了 Jinja2，您可以從 jinja 模板檔案建立模型卡。讓我們看一個基本示例

from pathlib import Path

from huggingface_hub import ModelCard, ModelCardData

# Define your jinja template
template_text = """
---
{{ card_data }}
---

# Model Card for MyCoolModel

This model does this and that.

This model was created by [@{{ author }}](https://huggingface.co/{{author}}).
""".strip()

# Write the template to a file
Path('custom_template.md').write_text(template_text)

# Define card metadata
card_data = ModelCardData(language='en', license='mit', library_name='keras')

# Create card from template, passing it any jinja template variables you want.
# In our case, we'll pass author
card = ModelCard.from_template(card_data, template_path='custom_template.md', author='nateraw')
card.save('my_model_card_1.md')
print(card)

生成的卡片的 markdown 如下所示

---
language: en
license: mit
library_name: keras
---

# Model Card for MyCoolModel

This model does this and that.

This model was created by [@nateraw](https://huggingface.co/nateraw).

如果您更新了任何 card.data，它都會反映在卡片本身中。

card.data.library_name = 'timm'
card.data.language = 'fr'
card.data.license = 'apache-2.0'
print(card)

現在，正如您所見，元資料頭部已更新

---
language: fr
license: apache-2.0
library_name: timm
---

# Model Card for MyCoolModel

This model does this and that.

This model was created by [@nateraw](https://huggingface.co/nateraw).

當您更新卡片資料時，可以透過呼叫 ModelCard.validate() 來驗證卡片是否仍然符合 Hub 的要求。這確保卡片透過 Hugging Face Hub 上設定的任何驗證規則。

從預設模板建立

除了使用自己的模板，您還可以使用 預設模板，這是一個功能齊全的模型卡，包含許多您可以填寫的章節。在底層，它使用 Jinja2 來填充模板檔案。

請注意，您必須安裝 Jinja2 才能使用 from_template。您可以使用 pip install Jinja2 來安裝。

card_data = ModelCardData(language='en', license='mit', library_name='keras')
card = ModelCard.from_template(
    card_data,
    model_id='my-cool-model',
    model_description="this model does this and that",
    developers="Nate Raw",
    repo="https://github.com/huggingface/huggingface_hub",
)
card.save('my_model_card_2.md')
print(card)

分享模型卡

如果您已透過 hf auth login 或 login() 登入 Hugging Face Hub，您可以透過簡單地呼叫 ModelCard.push_to_hub() 來將卡片推送到 Hub。讓我們看看如何做到這一點...

首先，我們將在已認證使用者的名稱空間下建立一個名為 'hf-hub-modelcards-pr-test' 的新倉庫

from huggingface_hub import whoami, create_repo

user = whoami()['name']
repo_id = f'{user}/hf-hub-modelcards-pr-test'
url = create_repo(repo_id, exist_ok=True)

然後，我們將從預設模板（與上面部分定義的相同）建立一個卡片

card_data = ModelCardData(language='en', license='mit', library_name='keras')
card = ModelCard.from_template(
    card_data,
    model_id='my-cool-model',
    model_description="this model does this and that",
    developers="Nate Raw",
    repo="https://github.com/huggingface/huggingface_hub",
)

最後，我們將把卡片推送到 Hub

card.push_to_hub(repo_id)

您可以在 這裡 檢視生成的卡片。

如果您想將卡片作為拉取請求推送，只需在呼叫 push_to_hub 時將 create_pr=True。

card.push_to_hub(repo_id, create_pr=True)

由此命令建立的 PR 可以在 這裡 檢視。

更新元資料

在本節中，我們將瞭解倉庫卡片中包含哪些元資料以及如何更新它們。

metadata 指的是一個雜湊對映（或鍵值）上下文，它提供了關於模型、資料集或 Space 的一些高階資訊。這些資訊可以包括模型的 pipeline type、model_id 或 model_description 等細節。有關更多詳細資訊，您可以檢視以下指南：模型卡、資料集卡和Spaces 設定。現在讓我們看一些關於如何更新這些元資料的示例。

讓我們從第一個示例開始

>>> from huggingface_hub import metadata_update
>>> metadata_update("username/my-cool-model", {"pipeline_tag": "image-classification"})

使用這兩行程式碼，您將更新元資料以設定一個新的 pipeline_tag。

預設情況下，您無法更新卡片上已存在的鍵。如果您想這樣做，必須顯式傳遞 overwrite=True。

>>> from huggingface_hub import metadata_update
>>> metadata_update("username/my-cool-model", {"pipeline_tag": "text-generation"}, overwrite=True)

您經常會遇到想要建議修改您沒有寫入許可權的倉庫的情況。您可以透過在該倉庫上建立 PR 來實現這一點，該 PR 將允許所有者審查和合並您的建議。

>>> from huggingface_hub import metadata_update
>>> metadata_update("someone/model", {"pipeline_tag": "text-classification"}, create_pr=True)

包含評估結果

要將評估結果包含在元資料 model-index 中，您可以傳遞一個 EvalResult 或一個 EvalResult 列表以及您相關的評估結果。在底層，當您呼叫 card.data.to_dict() 時，它將建立 model-index。有關此工作原理的更多資訊，您可以檢視 Hub 文件的 此部分。

請注意，使用此函式需要在 ModelCardData 中包含 model_name 屬性。

card_data = ModelCardData(
    language='en',
    license='mit',
    model_name='my-cool-model',
    eval_results = EvalResult(
        task_type='image-classification',
        dataset_type='beans',
        dataset_name='Beans',
        metric_type='accuracy',
        metric_value=0.7
    )
)

card = ModelCard.from_template(card_data)
print(card.data)

生成的 card.data 應如下所示

language: en
license: mit
model-index:
- name: my-cool-model
  results:
  - task:
      type: image-classification
    dataset:
      name: Beans
      type: beans
    metrics:
    - type: accuracy
      value: 0.7

如果您有多個評估結果想要分享，只需傳遞一個 EvalResult 列表

card_data = ModelCardData(
    language='en',
    license='mit',
    model_name='my-cool-model',
    eval_results = [
        EvalResult(
            task_type='image-classification',
            dataset_type='beans',
            dataset_name='Beans',
            metric_type='accuracy',
            metric_value=0.7
        ),
        EvalResult(
            task_type='image-classification',
            dataset_type='beans',
            dataset_name='Beans',
            metric_type='f1',
            metric_value=0.65
        )
    ]
)
card = ModelCard.from_template(card_data)
card.data

這應該會為您留下以下 card.data

language: en
license: mit
model-index:
- name: my-cool-model
  results:
  - task:
      type: image-classification
    dataset:
      name: Beans
      type: beans
    metrics:
    - type: accuracy
      value: 0.7
    - type: f1
      value: 0.65
在 GitHub 上更新

←快取 管理您的 Space→
© . This site is unofficial and not affiliated with Hugging Face, Inc.