Hub Python 库文档
与讨论和拉取请求互动
并获得增强的文档体验
开始使用
与讨论和拉取请求互动
查看 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()
数据结构
class huggingface_hub.Discussion
< source >( title: str status: typing.Literal['open', 'closed', 'merged', 'draft'] 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, 可选) — (属性) 如果这是一个拉取请求，则可以推送更改的 Git 引用，否则为None。 - url (
str) — (属性) Hub 上讨论的 URL。
Hub 上的讨论或拉取请求。
此数据类不应直接实例化。
class huggingface_hub.DiscussionWithDetails
< source >( title: str status: typing.Literal['open', 'closed', 'merged', 'draft'] num: int repo_id: str repo_type: str author: str is_pull_request: bool created_at: datetime endpoint: str events: typing.List[ForwardRef('DiscussionEvent')] conflicting_files: typing.Union[typing.List[str], bool, NoneType] target_branch: typing.Optional[str] merge_commit_oid: typing.Optional[str] diff: typing.Optional[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。 - events (
listof DiscussionEvent) — 此讨论或拉取请求中的DiscussionEvents列表。 - conflicting_files (
Union[List[str], bool, None], 可选) — 如果这是拉取请求，则为冲突文件列表。如果self.is_pull_request为False，则为None。如果存在冲突文件但无法检索列表，则为True。 - target_branch (
str, 可选) — 如果这是拉取请求，则为要合并更改的目标分支。如果self.is_pull_request为False，则为None。 - merge_commit_oid (
str, 可选) — 如果这是已合并的拉取请求，则设置为合并提交的 OID/SHA，否则为None。 - diff (
str, 可选) — 如果这是拉取请求，则为 Git diff，否则为None。 - endpoint (
str) — Hub 的端点。默认为 https://huggingface.co。 - git_reference (
str, 可选) — (属性) 如果这是一个拉取请求，则可以推送更改的 Git 引用，否则为None。 - url (
str) — (属性) Hub 上讨论的 URL。
Discussion 的子类。
class huggingface_hub.DiscussionEvent
< source >( id: str type: str created_at: datetime author: str _event: dict )
参数
- id (
str) — 事件的 ID。一个十六进制字符串。 - type (
str) — 事件的类型。 - created_at (
datetime) — 一个datetime对象，保存事件的创建时间戳。 - author (
str) — 讨论/拉取请求作者的用户名。如果用户已被删除，则可以为"deleted"。
讨论或拉取请求中的事件。
使用具体类
class 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) — 此注释是否已被编辑。 - hidden (
bool) — 此注释是否已被隐藏。
讨论/拉取请求中的注释。
DiscussionEvent 的子类。
class huggingface_hub.DiscussionStatusChange
< source >( 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
< 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 的子类。
class huggingface_hub.DiscussionTitleChange
< source >( 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 的子类。