Hugging Face's logo

Hub Python 库文档

与讨论和拉取请求互动

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

与讨论和拉取请求互动

请查看 HfApi 文档页面，以获取有关启用与 Hub 上的拉取请求和讨论互动的参考方法。

数据结构

class huggingface_hub.Discussion

< >

( title: str status: Literal num: int repo_id: str repo_type: str author: str is_pull_request: bool created_at: datetime endpoint: str )

参数

  • title (str) — 讨论 / 拉取请求的标题
  • status (str) — 讨论 / 拉取请求的状态。必须是以下之一：
    • "open"
    • "closed"
    • "merged" (仅用于拉取请求)
    • "draft" (仅用于拉取请求)
  • num (int) — 讨论 / 拉取请求的编号。
  • repo_id (str) — 讨论 / 拉取请求在其上打开的仓库的 ID ("{namespace}/{repo_name}")。
  • repo_type (str) — 讨论 / 拉取请求在其上打开的仓库的类型。可能的值为："model"、"dataset"、"space"。
  • author (str) — 讨论 / 拉取请求作者的用户名。如果用户此后已被删除，则可以为 "deleted"。
  • is_pull_request (bool) — 这是否为拉取请求。
  • created_at (datetime) — 讨论 / 拉取请求的创建时间 datetime。
  • endpoint (str) — Hub 的端点。默认为 https://huggingface.co。
  • git_reference (str, optional) — (属性) 如果这是拉取请求，则可以向其推送更改的 Git 引用，否则为 None。
  • url (str) — (属性) Hub 上讨论的 URL。

Hub 上的讨论或拉取请求。

此数据类不应直接实例化。

class huggingface_hub.DiscussionWithDetails

< >

( title: str status: Literal num: int repo_id: str repo_type: str author: str is_pull_request: bool created_at: datetime endpoint: str events: List conflicting_files: Union target_branch: Optional merge_commit_oid: Optional diff: Optional )

参数

  • title (str) — 讨论 / 拉取请求的标题
  • status (str) — Discussion/Pull Request 的状态。它可以是以下之一：
    • "open"（开启）
    • "closed"（关闭）
    • "merged"（已合并）（仅用于 Pull Request）
    • "draft"（草稿）（仅用于 Pull Request）
  • num (int) — Discussion/Pull Request 的编号。
  • repo_id (str) — 仓库的 ID ("{namespace}/{repo_name}")，Discussion/Pull Request 在该仓库上发起。
  • repo_type (str) — Discussion/Pull Request 在其上发起的仓库类型。可能的值有："model"（模型）, "dataset"（数据集）, "space"（空间）。
  • author (str) — Discussion/Pull Request 作者的用户名。如果用户之后被删除，则可以是 "deleted"。
  • is_pull_request (bool) — 是否为 Pull Request。
  • created_at (datetime) — Discussion/Pull Request 的创建 datetime 时间戳。
  • events (list of DiscussionEvent) — 此 Discussion 或 Pull Request 中的 DiscussionEvent 列表。
  • conflicting_files (Union[List[str], bool, None], optional) — 如果这是一个 Pull Request，则为冲突文件列表。如果 self.is_pull_request 为 False，则为 None。如果存在冲突文件但无法检索列表，则为 True。
  • target_branch (str, optional) — 如果这是一个 Pull Request，则更改要合并到的分支。如果 self.is_pull_request 为 False，则为 None。
  • merge_commit_oid (str, optional) — 如果这是一个已合并的 Pull Request，则此项设置为合并提交的 OID/SHA，否则为 None。
  • diff (str, optional) — 如果这是一个 Pull Request，则为 git diff，否则为 None。
  • endpoint (str) — Hub 的端点。默认为 https://huggingface.co。
  • git_reference (str, optional) — (属性) 如果这是一个 Pull Request，则可以将更改推送到的 Git 引用，否则为 None。
  • url (str) — (属性) Hub 上的 Discussion 的 URL。

Discussion 的子类。

class huggingface_hub.DiscussionEvent

< >

( id: str type: str created_at: datetime author: str _event: dict )

参数

  • id (str) — 事件的 ID。一个十六进制字符串。
  • type (str) — 事件的类型。
  • created_at (datetime) — 一个 datetime 对象，表示事件的创建时间戳。
  • author (str) — Discussion/Pull Request 作者的用户名。如果用户之后被删除，则可以是 "deleted"。

Discussion 或 Pull Request 中的一个事件。

使用具体类：

class huggingface_hub.DiscussionComment

< >

( id: str type: str created_at: datetime author: str _event: dict content: str edited: bool hidden: bool )

参数

  • id (str) — 事件的 ID。一个十六进制字符串。
  • type (str) — 事件的类型。
  • created_at (datetime) — 一个 datetime 对象，表示事件的创建时间戳。
  • author (str) — Discussion/Pull Request 作者的用户名。如果用户之后被删除，则可以是 "deleted"。
  • content (str) — 评论的原始 Markdown 内容。提及、链接和图像未渲染。
  • edited (bool) — 此评论是否被编辑过。
  • hidden (bool) — 此评论是否被隐藏。

Discussion/Pull Request 中的评论。

DiscussionEvent 的子类。

class huggingface_hub.DiscussionStatusChange

< >

( id: str type: str created_at: datetime author: str _event: dict new_status: str )

参数

  • id (str) — 事件的 ID。十六进制字符串。
  • type (str) — 事件的类型。
  • created_at (datetime) — datetime 对象，保存事件的创建时间戳。
  • author (str) — 讨论/拉取请求作者的用户名。如果用户已被删除，则可以为 "deleted"。
  • new_status (str) — 更改后讨论/拉取请求的状态。它可以是以下之一：
    • "open"
    • "closed"
    • "merged" (仅适用于拉取请求)

讨论/拉取请求中的状态更改。

DiscussionEvent 的子类。

class huggingface_hub.DiscussionCommit

< >

( id: str type: str created_at: datetime author: str _event: dict summary: str oid: str )

参数

  • id (str) — 事件的 ID。十六进制字符串。
  • type (str) — 事件的类型。
  • created_at (datetime) — datetime 对象，保存事件的创建时间戳。
  • author (str) — 讨论/拉取请求作者的用户名。如果用户已被删除，则可以为 "deleted"。
  • summary (str) — commit 的摘要。
  • oid (str) — commit 的 OID / SHA，作为十六进制字符串。

拉取请求中的一个 commit。

DiscussionEvent 的子类。

class huggingface_hub.DiscussionTitleChange

< >

( id: str type: str created_at: datetime author: str _event: dict old_title: str new_title: str )

参数

  • id (str) — 事件的 ID。十六进制字符串。
  • type (str) — 事件的类型。
  • created_at (datetime) — datetime 对象，保存事件的创建时间戳。
  • author (str) — 讨论/拉取请求作者的用户名。如果用户已被删除，则可以为 "deleted"。
  • old_title (str) — 讨论/拉取请求之前的标题。
  • new_title (str) — 新标题。

讨论/拉取请求中的重命名事件。

DiscussionEvent 的子类。

< > Update on GitHub

←Utilities Cache-system reference→