Hugging Face 的 logo

Hub Python 库文档

管理本地和在线存储库

Hugging Face's logo
加入 Hugging Face 社区

并获得增强文档体验

开始使用

管理本地和在线仓库

Repository 类是一个包装了 git 和 git-lfs 命令的辅助类。它提供了适用于管理可能非常大的仓库的工具。

只要涉及任何 git 操作，或者当协作将成为仓库本身的重点时，建议使用此工具。

Repository 类

类 huggingface_hub.Repository

< >

( local_dir: Union clone_from: Optional = None repo_type: Optional = None token: Union = True git_user: Optional = None git_email: Optional = None revision: Optional = None skip_lfs_files: bool = False client: Optional = None )

用于封装 git 和 git-lfs 命令的辅助类。

其目的是方便与 huggingface.co 托管的模型或数据集仓库进行交互，尽管这里的大部分内容（如果有的话）实际上并不是 huggingface.co 特有的。

Repository 已弃用，推荐使用 HfApi 中实现的基于 HTTP 的替代方案。考虑到它在遗留代码中的广泛采用，Repository 将仅在 v1.0 版本中完全移除。有关更多详细信息，请阅读 https://huggingface.co/docs/huggingface_hub/concepts/git_vs_http。

__init__

< >

( local_dir: Union clone_from: Optional = None repo_type: Optional = None token: Union = True git_user: Optional = None git_email: Optional = None revision: Optional = None skip_lfs_files: bool = False client: Optional = None )

参数

  • local_dir (str 或 Path) — 本地目录的路径（例如 'my_trained_model/'），将在其中初始化 Repository。
  • clone_from (str, 可选) — 仓库 URL 或 repo_id。示例：
    • "https://huggingface.co/philschmid/playground-tests"
    • "philschmid/playground-tests"
  • repo_type (str, 可选) — 从 repo_id 克隆仓库时设置。默认值为“model”。
  • token （bool 或 str，可选） — 一个有效的身份验证令牌（请参阅 https://huggingface.co/settings/token）。如果为 None 或 True 并且机器已登录（通过 huggingface-cli login 或 login()），则将从缓存中检索令牌。如果为 False，则不会在请求标头中发送令牌。
  • git_user （str，可选） — 将覆盖用于提交和推送文件到 Hub 的 git config user.name。
  • git_email （str，可选） — 将覆盖用于提交和推送文件到 Hub 的 git config user.email。
  • revision （str，可选） — 初始化存储库后要检出的版本。如果该版本不存在，则将使用默认分支的当前 HEAD 创建一个名称为该版本的 branch 。
  • skip_lfs_files （bool，可选，默认为 False） — 是否跳过 git-LFS 文件。
  • client （HfApi，可选） — 调用 HF Hub API 时使用的 HfApi 实例。如果将其保留为 None，则会创建一个新实例。

引发

EnvironmentError

  • EnvironmentError — 如果在 clone_from 中设置的远程存储库不存在。

实例化 git 存储库的本地克隆。

如果设置了 clone_from，则存储库将从现有的远程存储库克隆。如果远程存储库不存在，则会引发 EnvironmentError 异常。请先使用 create_repo() 创建远程存储库。

Repository 默认使用本地 git 凭据。如果明确设置，则将使用 token 或 git_user/git_email 对。

current_branch

< >

( ) → str

返回值

str

当前检出的分支。

返回当前检出的分支。

add_tag

< >

( tag_name: str message: Optional = None remote: Optional = None )

参数

  • tag_name (str) — 要添加的标签名称。
  • message (str, 可选) — 随附于标签的消息。如果传递了消息，该标签将变成带注释的标签。
  • remote (str, 可选) — 要在其上添加标签的远程仓库。

在当前HEAD添加一个标签并推送

如果remote为None，则仅在本地更新

如果没有提供消息，则该标签将是轻量级的。如果提供了消息，则该标签将被注释。

auto_track_binary_files

< >

( pattern: str = '.' ) → List[str]

参数

  • pattern (str, 可选, 默认值 ”.“) — 用于跟踪二进制文件的模式。

返回值

List[str]

现在由于是二进制文件而被跟踪的文件名列表

使用git-lfs自动跟踪二进制文件。

auto_track_large_files

< >

( pattern: str = '.' ) → List[str]

参数

  • pattern (str, 可选, 默认为 ”.“) — 用于跟踪大于 10MB 文件的模式。

返回值

List[str]

由于大小原因现在被跟踪的文件名列表。

使用 git-lfs 自动跟踪大文件（大于 10MB 的文件）。

check_git_versions

< >

( )

引发

EnvironmentError

检查是否可以运行 git 和 git-lfs。

clone_from

< >

( repo_url: str token: Union = None )

参数

  • repo_url (str) — 要从中克隆仓库的 URL
  • token (Union[str, bool], 可选) — 是否使用身份验证令牌。可以是：
    • 字符串，即令牌本身
    • False，不使用身份验证令牌
    • True，将从本地文件夹获取身份验证令牌并使用它（您应该登录才能使其工作）。
    • None，将检索 self.huggingface_token 的值。

从远程克隆。如果文件夹已存在，将尝试在其内部克隆仓库。

如果此文件夹是具有链接历史记录的 git 仓库，将尝试更新仓库。

引发以下错误

commit

< >

( commit_message: str branch: Optional = None track_large_files: bool = True blocking: bool = True auto_lfs_prune: bool = False )

参数

  • commit_message (str) — 用于提交的信息。
  • branch (str, 可选) — 提交将出现在哪个分支上。 在任何操作之前，都会检出此分支。
  • track_large_files (bool, 可选, 默认为 True) — 是否自动跟踪大文件。 默认情况下会这样做。
  • blocking (bool, 可选, 默认为 True) — 该函数是否应仅在 git push 完成后返回。
  • auto_lfs_prune (bool, 默认为 True) — 文件推送到远程后是否自动修剪文件。

用于处理提交到存储库的上下文管理器实用程序。 这将使用 git-lfs 自动跟踪大文件（大于 10Mb）。 如果您希望忽略该行为，请将 track_large_files 参数设置为 False。

示例

>>> with Repository(
...     "text-files",
...     clone_from="<user>/text-files",
...     token=True,
>>> ).commit("My first file :)"):
...     with open("file.txt", "w+") as f:
...         f.write(json.dumps({"hey": 8}))

>>> import torch

>>> model = torch.nn.Transformer()
>>> with Repository(
...     "torch-model",
...     clone_from="<user>/torch-model",
...     token=True,
>>> ).commit("My cool model :)"):
...     torch.save(model.state_dict(), "model.pt")

delete_tag

< >

( tag_name: str remote: Optional = None ) → bool

参数

  • tag_name (str) — 要删除的标签名称。
  • remote (str, 可选) — 要删除标签的远程仓库。

返回值

bool

如果删除成功则返回 True，如果标签不存在则返回 False。 如果未传递 remote 参数，则仅在本地更新

删除一个标签，如果存在，则同时删除本地和远程标签

git_add

< >

( pattern: str = '.' auto_lfs_track: bool = False )

参数

  • pattern (str, 可选, 默认为 ”.“) — 用于将文件添加到暂存区的模式。
  • auto_lfs_track (bool, 可选, 默认为 False) — 是否使用 git-lfs 自动跟踪大文件和二进制文件。 任何大于 10MB 或采用二进制格式的文件都将被自动跟踪。

git add

将 auto_lfs_track 参数设置为 True 将使用 git-lfs 自动跟踪大于 10MB 的文件。

git_checkout

< >

( revision: str create_branch_ok: bool = False )

参数

  • revision (str) — 要检出的版本。
  • create_branch_ok (str, 可选, 默认值 False) — 如果传递的 revision 不是现有版本，是否允许在当前检出引用的位置创建一个以 revision 命名的分支。

git 检出一个给定的版本

如果给定的版本不存在，将 create_branch_ok 指定为 True 将创建指向该版本的分支。

git_commit

< >

( commit_message: str = 'commit files to HF hub' )

参数

  • commit_message (str, 可选, 默认值 “commit files to HF hub”) — 提交说明。

git 提交

git_config_username_and_email

< >

( git_user: Optional = None git_email: Optional = None )

参数

  • git_user (str, 可选) — 要通过 git 注册的用户名。
  • git_email (str, 可选) — 要通过 git 注册的电子邮件地址。

设置 git 用户名和电子邮件地址（仅限当前仓库）。

git_credential_helper_store

< >

( )

将 git 凭证助手设置为 store

git_head_commit_url

< >

( ) → str

返回值

str

当前签出提交的 URL。

获取 HEAD 上最后一次提交的 URL。我们假设它已经被推送，并且 URL 方案与 GitHub 或 HuggingFace 的 URL 方案相同。

git_head_hash

< >

( ) → str

返回值

str

当前签出的提交 SHA。

获取 HEAD 上的提交 sha。

git_pull

< >

( rebase: bool = False lfs: bool = False )

参数

  • rebase (bool，*可选*，默认为 False) — 获取后是否将当前分支 rebase 到上游分支之上。
  • lfs (bool，*可选*，默认为 False) — 是否同时获取 LFS 文件。仅当在未获取 LFS 文件的情况下克隆存储库时，此选项才会更改行为；调用 repo.git_pull(lfs=True) 将从远程存储库获取 LFS 文件。

git pull

git_push

< >

( upstream: Optional = None blocking: bool = True auto_lfs_prune: bool = False )

参数

  • upstream (str，可选) — 要推送到的上游。如果未指定，将推送到最后定义的上游或默认上游（origin main）。
  • blocking (bool，可选，默认为 True) — 该函数是否应仅在推送完成后返回。将其设置为 False 将返回一个 CommandInProgress 对象，该对象具有 is_done 属性。当推送完成后，此属性将设置为 True。
  • auto_lfs_prune (bool，可选，默认为 False) — 文件被推送到远程仓库后是否自动清理文件。

git push

如果在不设置 blocking 的情况下使用，将返回远程仓库上提交的 URL。如果与 blocking=True 一起使用，将返回一个元组，其中包含提交的 URL 和要遵循的命令对象，以获取有关该过程的信息。

git_remote_url

< >

( ) → str

返回值

str

origin 远程仓库的 URL。

获取 origin 远程仓库的 URL。

is_repo_clean

< >

( ) → bool

返回值

bool

如果 git 状态干净，则为 True，否则为 False。

返回 git 状态是否干净。

lfs_enable_largefiles

< >

( )

特定于 HF。这将启用对 >5GB 文件的上传支持。

lfs_prune

< >

( recent = False )

参数

  • recent (bool, 可选, 默认为 False) — 是否即使最近的提交引用了文件也要修剪文件。有关详细信息，请参阅以下 链接。

git lfs prune

lfs_track

< >

( patterns: Union filename: bool = False )

参数

  • patterns (Union[str, List[str]]) — 要使用 git-lfs 跟踪的模式或模式列表。
  • filename (bool, 可选, 默认为 False) — 是否将模式用作文字文件名。

告诉 git-lfs 根据模式跟踪文件。

将 filename 参数设置为 True 会将参数视为文字文件名，而不是模式。写入 .gitattributes 文件时，文件名中的任何特殊 glob 字符都将被转义。

lfs_untrack

< >

( patterns: Union )

参数

  • patterns (Union[str, List[str]]) — 要使用 git-lfs 取消跟踪的模式或模式列表。

告诉 git-lfs 取消跟踪这些文件。

list_deleted_files

< >

( ) → List[str]

返回值

List[str]

已在工作目录或索引中删除的文件列表。

返回已在工作目录或索引中删除的文件列表。

push_to_hub

< >

( commit_message: str = 'commit files to HF hub' blocking: bool = True clean_ok: bool = True auto_lfs_prune: bool = False )

参数

  • commit_message (str) — 用于提交的讯息。
  • blocking (bool, 可选, 默认为 True) — 函数是否应该只在 git push 完成时返回。
  • clean_ok (bool, 可选, 默认为 True) — 如果为 True，则如果存储库未被触及，此函数将返回 None。 默认行为是失败，因为 git 命令失败。
  • auto_lfs_prune (bool，*可选*，默认为 False) — 是否在文件被推送到远程后自动删除。

辅助函数，用于将文件添加到 HuggingFace Hub 上的远程存储库、提交和推送文件。将自动跟踪大文件（>10MB）。

tag_exists

< >

( tag_name: str remote: Optional = None ) → bool

参数

  • tag_name (str) — 要检查的标签名称。
  • remote (str, *可选*) — 是否检查远程上是否存在标签。此参数应为远程的标识符。

返回值

bool

标签是否存在。

检查标签是否存在。

wait_for_commands

< >

( )

阻塞方法：阻塞所有后续执行，直到所有命令都已处理完毕。

辅助方法

huggingface_hub.repository.is_git_repo

< >

( folder: Union ) → bool

参数

  • folder (str) — 要在其中运行命令的文件夹。

返回值

bool

如果仓库是仓库的一部分，则为 True，否则为 False。

检查文件夹是 git 仓库的根目录还是其中的一部分

huggingface_hub.repository.is_local_clone

< >

( folder: Union remote_url: str ) → bool

参数

  • folder (str 或 Path) — 要在其中运行命令的文件夹。
  • remote_url (str) — git 仓库的 URL。

返回值

bool

如果仓库是指定远程仓库的本地克隆，则为 True，否则为 False。

检查文件夹是否是 remote_url 的本地克隆

huggingface_hub.repository.is_tracked_with_lfs

< >

( filename: Union ) → bool

参数

  • filename (str 或 Path) — 要检查的文件名。

返回值

bool

如果传递的文件使用 git-lfs 进行跟踪，则为 True，否则为 False。

检查传递的文件是否使用 git-lfs 进行跟踪。

huggingface_hub.repository.is_git_ignored

< >

( filename: Union ) → bool

参数

  • filename (str 或 Path) — 要检查的文件名。

返回值

bool

如果传递的文件被 git 忽略，则为 True，否则为 False。

检查文件是否被 git 忽略。支持嵌套的 .gitignore 文件。

huggingface_hub.repository.files_to_be_staged

< >

( pattern: str = '.' folder: Union = None ) → List[str]

参数

  • pattern (str 或 Path) — 要检查的文件名模式。输入 . 获取所有文件。
  • folder (str 或 Path) — 要在其中运行命令的文件夹。

返回值

List[str]

要暂存的文件列表。

返回要暂存的文件名列表。

huggingface_hub.repository.is_tracked_upstream

< >

( folder: Union ) → bool

参数

  • folder (str 或 Path) — 要在其中运行命令的文件夹。

返回值

bool

如果当前签出的分支被上游跟踪，则为 True，否则为 False。

检查当前签出的分支是否被上游跟踪。

huggingface_hub.repository.commits_to_push

< >

( folder: Union upstream: Optional = None ) → int

参数

  • folder (str 或 Path) — 运行命令的文件夹。
  • upstream (str，可选) —

返回值

int

如果执行 git push，将推送到上游的提交次数。

检查将要推送到上游的提交次数

要与其进行比较的上游存储库的名称。

以下异步命令

Repository 工具提供了几个可以异步启动的方法

  • git_push
  • git_pull
  • push_to_hub
  • commit 上下文管理器

有关管理此类异步方法的实用程序，请参见下文。

类 huggingface_hub.Repository

< >

( local_dir: Union clone_from: Optional = None repo_type: Optional = None token: Union = True git_user: Optional = None git_email: Optional = None revision: Optional = None skip_lfs_files: bool = False client: Optional = None )

用于封装 git 和 git-lfs 命令的辅助类。

其目的是方便与 huggingface.co 托管的模型或数据集仓库进行交互，尽管这里的大部分内容（如果有的话）实际上并不是 huggingface.co 特有的。

Repository 已弃用，推荐使用 HfApi 中实现的基于 HTTP 的替代方案。考虑到它在遗留代码中的广泛采用，Repository 将仅在 v1.0 版本中完全移除。有关更多详细信息，请阅读 https://huggingface.co/docs/huggingface_hub/concepts/git_vs_http。

commands_failed

< >

( )

返回失败的异步命令。

commands_in_progress

< >

( )

返回当前正在进行的异步命令。

wait_for_commands

< >

( )

阻塞方法：阻塞所有后续执行，直到所有命令都已处理完毕。

类 huggingface_hub.repository.CommandInProgress

< >

( title: str is_done_method: Callable status_method: Callable process: Popen post_method: Optional = None )

用于跟踪异步启动命令的实用程序。

< > 更新 GitHub 上

←环境变量 Hugging Face Hub API→