与讨论和拉取请求交互
请查阅 HfApi 文档页面，以了解可启用与 Hub 上的拉取请求和讨论交互的方法。
- get_repo_discussions()
- get_discussion_details()
- create_discussion()
- create_pull_request()
- rename_discussion()
- comment_discussion()
- edit_discussion_comment()
- change_discussion_status()
- merge_pull_request()
数据结构
类 huggingface_hub.Discussion
< 来源 >( 标题: 字符串 状态: 文字 数字: 整数 仓库ID: 字符串 仓库类型: 字符串 作者: 字符串 是否为拉取请求: 布尔值 创建时间: 时间日期 端点: 字符串 )
参数
- 标题 (
字符串) — 讨论或拉取请求的标题 - 状态 (
字符串) — 讨论或拉取请求的状态。它必须是以下之一："open""closed""merged"（仅限拉取请求）"draft"（仅限拉取请求）
- num (
int) — 讨论或合并请求的编号。 - repo_id (
str) — 讨论或合并请求所在的仓库的ID（格式为＜"namespace＞/＜repo_name＞"）。 - repo_type (
str) — 讨论或合并请求打开的仓库类型。可能的值为：＜code>modeldatasetspace - author (
str) — 讨论或合并请求作者的用户名。如果用户已被删除，则可以是＜code>deleted。 - is_pull_request (
布尔值) — 是否为 Pull Request。 - created_at (
datetime) — 讨论/Pull Request 的创建时间。 - endpoint (
字符串) — Hub 的端点。默认为 https://huggingface.co。 - git_reference (
字符串, 可选) — 如果这是 Pull Request，则可以 push 变更的 Git 引用，否则为None。 - url (
str) — （属性）在 Hub 上的讨论 URL。
Hub 上的讨论或拉取请求。
此数据类不打算直接实例化。
类 huggingface_hub.DiscussionWithDetails
< 源代码 >( 标题: str 状态: Literal 编号: int 仓库 ID: str 仓库类型: str 作者: str 是否为拉取请求: bool 创建时间: datetime 端点: str 事件: List 冲突文件: Union 目标分支: Optional 合并提交 OID: Optional 差异: Optional )
参数
- 标题 (
str) — 讨论或拉取请求的标题 - 状态 (
str) — 讨论或拉取请求的状态。可以是以下之一："open""closed""merged" (仅适用于拉取请求 )"draft" (仅适用于拉取请求 )
- 编号 (
int) — 讨论或拉取请求的编号。 - repo_id (
str) — 在上面对话/拉取请求打开的存储库的id ("{namespace}/{repo_name}")。 - repo_type (
str) — 在上面对话/拉取请求打开的存储库的类型。可能的值为："model"、"dataset"、"space"。 - author (
str) — 对话/拉取请求作者的登录名。如果用户已被删除，则可以是"deleted"。 - is_pull_request (
bool) — 是否为拉取请求。 - target_branch (
str, 可选) — 如果这是一个拉取请求，更改将合并到这个分支。当self.is_pull_request为False时为None。 - merge_commit_oid (
str, 可选) — 如果这是一个合并的拉取请求，这设置为合并提交的 OID / SHA，否则为None。 - diff (
str, 可选) — 如果这是一个拉取请求，这是 git diff，否则为None。 - endpoint (
str) — 门户端点。默认是 https://huggingface.co。 - git_reference (
str, optional) — 如果这是一个拉取请求，指向可以推送更改的 Git 引用，否则为None。 - url (
str) — 有关 Hub 上讨论的 URL。
是 Discussion 的子类。
类 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) — 讨论/拉取请求作者的昵称。如果自那时起用户已被删除，则可以是"deleted"。
讨论或拉取请求中的一个事件。
使用具体类。
类 huggingface_hub.DiscussionComment
< source >( 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) — 论坛或拉取请求作者的昵称。如果用户已被删除，则可能显示为"deleted"。 - content (
str) — 评论的原始 Markdown 内容。提及、链接和图片将不会渲染。 - edited (
bool) — 是否编辑过此评论。 - 隐藏 (
布尔值) — 此评论是否已被隐藏。
讨论/拉取请求中的评论。
继承自DiscussionEvent。
类 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) — 讨论或 Pull Request 作者的用户名。如果用户已被删除，可以是"deleted"。 - new_status (
str) — 事件变化后讨论或 Pull Request 的状态。可以是以下之一："open""closed""merged"（仅限 Pull Requests）
讨论或 Pull Request 状态的改变。
继承自DiscussionEvent。
类 huggingface_hub.DiscussionCommit
< source >( 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) — 提交的摘要。 - oid (
str) — 提交的 OID / SHA，以十六进制字符串形式。
拉取请求中的一个提交。
继承自DiscussionEvent。
类 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。