Hub Python Library documentation

Interagindo com Discussões e Pull Requests

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v2.4.0).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Interagindo com Discussões e Pull Requests

Consulte a página de documentação do HfApi para a referência dos métodos que permitem a interação com Pull Requests e Discussões no Hub.

Estruturas de dados

classe huggingface_hub.Discussion

< >

( title: strstatus: typing.Literal['open', 'closed', 'merged', 'draft']num: intrepo_id: strrepo_type: strauthor: stris_pull_request: boolcreated_at: datetimeendpoint: str )

Parâmetros

  • title (str) — O título da Discussion / Pull Request
  • status (str) — O status da Discussion / Pull Request. Deve ser um dos seguintes:
    • "open"
    • "closed"
    • "merged" (somente para Pull Requests)
    • "draft" (somente para Pull Requests)
  • num (int) — O número da Discussão / Pull Request.
  • repo_id (str) — O id ("{namespace}/{repo_name}") do repositório em que a Discussion / Pull Request estava aberta.
  • repo_type (str) — O tipo do repositório em que a Discussão / Pull Request estava aberta. Os valores possíveis são: "model", "dataset", "space".
  • author (str) — O nome de usuário do autor da Discussão / Pull Request. Pode ser "deleted" se o usuário tiver sido excluído desde então.
  • is_pull_request (bool) — Indica se este é um Pull Request.
  • created_at (datetime) — O datetime de criação da Discussion / Pull Request.
  • endpoint (str) — Endpoint do Hub. O padrão é https://huggingface.co.
  • git_reference (str, opcional) — (propriedade) Referência Git para a qual as alterações podem ser enviadas se esta for uma Pull Request, None caso contrário.
  • url (str) — (propriedade) URL da discussão no Hub.

Uma Discussão ou Pull Request no Hub.

Esta dataclass não foi projetada para ser instanciada diretamente.

classe huggingface_hub.DiscussionWithDetails

< >

( title: strstatus: typing.Literal['open', 'closed', 'merged', 'draft']num: intrepo_id: strrepo_type: strauthor: stris_pull_request: boolcreated_at: datetimeendpoint: strevents: listconflicting_files: list[str] | bool | Nonetarget_branch: str | Nonemerge_commit_oid: str | Nonediff: str | None )

Parâmetros

  • title (str) — O título da Discussion / Pull Request
  • status (str) — O status da Discussion / Pull Request. Pode ser um dos seguintes:
    • "open"
    • "closed"
    • "merged" (somente para Pull Requests)
    • "draft" (somente para Pull Requests)
  • num (int) — O número da Discussão / Pull Request.
  • repo_id (str) — O id ("{namespace}/{repo_name}") do repositório em que a Discussion / Pull Request estava aberta.
  • repo_type (str) — O tipo do repositório em que a Discussão / Pull Request estava aberta. Os valores possíveis são: "model", "dataset", "space".
  • author (str) — O nome de usuário do autor da Discussão / Pull Request. Pode ser "deleted" se o usuário tiver sido excluído desde então.
  • is_pull_request (bool) — Indica se este é um Pull Request.
  • created_at (datetime) — O datetime de criação da Discussion / Pull Request.
  • events (list de DiscussionEvent) — A lista de DiscussionEvents nesta Discussion ou Pull Request.
  • conflicting_files (Union[list[str], bool, None], opcional) — Uma lista de arquivos em conflito, se esta for uma Pull Request. None se self.is_pull_request for False. True se houver arquivos em conflito, mas a lista não puder ser recuperada.
  • target_branch (str, opcional) — O ramo no qual as alterações devem ser mescladas, caso se trate de um Pull Request. None se self.is_pull_request for False.
  • merge_commit_oid (str, opcional) — Se esta for uma Pull Request mesclada, este valor é definido como o OID/SHA do commit de mesclagem; caso contrário, é None.
  • diff (str, opcional) — O git diff, se for um Pull Request, None caso contrário.
  • endpoint (str) — Endpoint do Hub. O padrão é https://huggingface.co.
  • git_reference (str, opcional) — (propriedade) Referência Git para a qual as alterações podem ser enviadas se esta for uma Pull Request, None caso contrário.
  • url (str) — (propriedade) URL da discussão no Hub.

Subclasse de Discussion.

classe huggingface_hub.DiscussionEvent

< >

( id: strtype: strcreated_at: datetimeauthor: str_event: dict )

Parâmetros

  • id (str) — O ID do evento. Uma string hexadecimal.
  • type (str) — O tipo do evento.
  • created_at (datetime) — Um objeto datetime que armazena o timestamp de criação do evento.
  • author (str) — O nome de usuário do autor da Discussão / Pull Request. Pode ser "deleted" se o usuário tiver sido excluído desde então.

Um evento em uma Discussão ou Pull Request.

Use classes concretas:

classe huggingface_hub.DiscussionComment

< >

( id: strtype: strcreated_at: datetimeauthor: str_event: dictcontent: stredited: boolhidden: bool )

Parâmetros

  • id (str) — O ID do evento. Uma string hexadecimal.
  • type (str) — O tipo do evento.
  • created_at (datetime) — Um objeto datetime que armazena o timestamp de criação do evento.
  • author (str) — O nome de usuário do autor da Discussão / Pull Request. Pode ser "deleted" se o usuário tiver sido excluído desde então.
  • content (str) — O conteúdo bruto em markdown do comentário. Menções, links e imagens não são renderizados.
  • edited (bool) — Indica se este comentário foi editado ou não.
  • hidden (bool) — Indica se este comentário foi ocultado.

Um comentário em uma Discussão / Pull Request.

Subclasse de DiscussionEvent.

classe huggingface_hub.DiscussionStatusChange

< >

( id: strtype: strcreated_at: datetimeauthor: str_event: dictnew_status: str )

Parâmetros

  • id (str) — O ID do evento. Uma string hexadecimal.
  • type (str) — O tipo do evento.
  • created_at (datetime) — Um objeto datetime que armazena o timestamp de criação do evento.
  • author (str) — O nome de usuário do autor da Discussão / Pull Request. Pode ser "deleted" se o usuário tiver sido excluído desde então.
  • new_status (str) — O status da Discussion / Pull Request após a alteração. Pode ser um dos seguintes:
    • "open"
    • "closed"
    • "merged" (somente para Pull Requests)

Uma mudança de status em uma Discussão / Pull Request.

Subclasse de DiscussionEvent.

classe huggingface_hub.DiscussionCommit

< >

( id: strtype: strcreated_at: datetimeauthor: str_event: dictsummary: stroid: str )

Parâmetros

  • id (str) — O ID do evento. Uma string hexadecimal.
  • type (str) — O tipo do evento.
  • created_at (datetime) — Um objeto datetime que armazena o timestamp de criação do evento.
  • author (str) — O nome de usuário do autor da Discussão / Pull Request. Pode ser "deleted" se o usuário tiver sido excluído desde então.
  • summary (str) — O resumo do commit.
  • oid (str) — O OID / SHA do commit, como uma string hexadecimal.

Um commit em um Pull Request.

Subclasse de DiscussionEvent.

classe huggingface_hub.DiscussionTitleChange

< >

( id: strtype: strcreated_at: datetimeauthor: str_event: dictold_title: strnew_title: str )

Parâmetros

  • id (str) — O ID do evento. Uma string hexadecimal.
  • type (str) — O tipo do evento.
  • created_at (datetime) — Um objeto datetime que armazena o timestamp de criação do evento.
  • author (str) — O nome de usuário do autor da Discussão / Pull Request. Pode ser "deleted" se o usuário tiver sido excluído desde então.
  • old_title (str) — O título anterior da Discussion / Pull Request.
  • new_title (str) — O novo título.

Um evento de renomeação em uma Discussão / Pull Request.

Subclasse de DiscussionEvent.

Update on GitHub