Hub Python Library documentation

Interacción con discusiones y solicitudes de extracción

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

Interacción con discusiones y solicitudes de extracción

Consulte la página de documentación de HfApi para obtener la referencia de los métodos que permiten interactuar con Pull Requests y Discusiones en el Hub.

Estructuras de datos

clase 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) — El título de la Discusión / Pull Request
  • status (str) — El estado de la Discusión / Pull Request. Debe ser uno de:
    • "open"
    • "closed"
    • "merged" (solo para Pull Requests)
    • "draft" (solo para Pull Requests)
  • num (int) — El número de la Discusión / Solicitud de extracción.
  • repo_id (str) — El id ("{namespace}/{repo_name}") del repositorio en el que se abrió la Discusión / Pull Request.
  • repo_type (str) — El tipo de repositorio en el que se abrió la Discusión / Pull Request. Los valores posibles son: "model", "dataset", "space".
  • author (str) — El nombre de usuario del autor de la Discusión / Solicitud de extracción. Puede ser "deleted" si el usuario ha sido eliminado desde entonces.
  • is_pull_request (bool) — Indica si se trata de una Pull Request.
  • created_at (datetime) — La datetime de creación de la Discusión / Pull Request.
  • endpoint (str) — Endpoint del Hub. El valor predeterminado es https://huggingface.co.
  • git_reference (str, opcional) — (propiedad) Referencia de Git a la que se pueden enviar los cambios si se trata de una Pull Request, None en caso contrario.
  • url (str) — (propiedad) URL de la discusión en el Hub.

Una discusión o solicitud de incorporación de cambios (Pull Request) en el Hub.

Esta dataclass no está destinada a instanciarse directamente.

clase 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) — El título de la Discusión / Pull Request
  • status (str) — El estado de la Discusión / Pull Request. Puede ser uno de los siguientes:
    • "open"
    • "closed"
    • "merged" (solo para Pull Requests)
    • "draft" (solo para Pull Requests)
  • num (int) — El número de la Discusión / Solicitud de extracción.
  • repo_id (str) — El id ("{namespace}/{repo_name}") del repositorio en el que se abrió la Discusión / Pull Request.
  • repo_type (str) — El tipo de repositorio en el que se abrió la Discusión / Pull Request. Los valores posibles son: "model", "dataset", "space".
  • author (str) — El nombre de usuario del autor de la Discusión / Solicitud de extracción. Puede ser "deleted" si el usuario ha sido eliminado desde entonces.
  • is_pull_request (bool) — Indica si se trata de una Pull Request.
  • created_at (datetime) — La datetime de creación de la Discusión / Pull Request.
  • events (list de DiscussionEvent) — La lista de DiscussionEvents en esta Discussion o Pull Request.
  • conflicting_files (Union[list[str], bool, None], opcional) — Una lista de archivos en conflicto si se trata de una Pull Request. None si self.is_pull_request es False. True si hay archivos en conflicto pero no se puede obtener la lista.
  • target_branch (str, opcional) — La rama en la que se van a fusionar los cambios si se trata de un Pull Request. None si self.is_pull_request es False.
  • merge_commit_oid (str, opcional) — Si se trata de un Pull Request fusionado, se establece en el OID/SHA del commit de fusión; en caso contrario, None.
  • diff (str, opcional) — La diferencia de git si se trata de una Pull Request, None en caso contrario.
  • endpoint (str) — Endpoint del Hub. El valor predeterminado es https://huggingface.co.
  • git_reference (str, opcional) — (propiedad) Referencia de Git a la que se pueden enviar los cambios si se trata de una Pull Request, None en caso contrario.
  • url (str) — (propiedad) URL de la discusión en el Hub.

Subclase de Discussion.

clase huggingface_hub.DiscussionEvent

< >

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

Parámetros

  • id (str) — El ID del evento. Una cadena hexadecimal.
  • type (str) — El tipo del evento.
  • created_at (datetime) — Un objeto datetime que contiene la marca de tiempo de creación del evento.
  • author (str) — El nombre de usuario del autor de la Discusión / Solicitud de extracción. Puede ser "deleted" si el usuario ha sido eliminado desde entonces.

Un evento en una Discusión o Pull Request.

Use clases concretas:

clase huggingface_hub.DiscussionComment

< >

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

Parámetros

  • id (str) — El ID del evento. Una cadena hexadecimal.
  • type (str) — El tipo del evento.
  • created_at (datetime) — Un objeto datetime que contiene la marca de tiempo de creación del evento.
  • author (str) — El nombre de usuario del autor de la Discusión / Solicitud de extracción. Puede ser "deleted" si el usuario ha sido eliminado desde entonces.
  • content (str) — El contenido markdown sin procesar del comentario. Las menciones, los enlaces y las imágenes no se renderizan.
  • edited (bool) — Indica si este comentario ha sido editado.
  • hidden (bool) — Indica si este comentario se ha ocultado o no.

Un comentario en una Discusión / Solicitud de extracción (Pull Request).

Subclase de DiscussionEvent.

clase huggingface_hub.DiscussionStatusChange

< >

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

Parámetros

  • id (str) — El ID del evento. Una cadena hexadecimal.
  • type (str) — El tipo del evento.
  • created_at (datetime) — Un objeto datetime que contiene la marca de tiempo de creación del evento.
  • author (str) — El nombre de usuario del autor de la Discusión / Solicitud de extracción. Puede ser "deleted" si el usuario ha sido eliminado desde entonces.
  • new_status (str) — El estado de la Discusión / Pull Request después del cambio. Puede ser uno de:
    • "open"
    • "closed"
    • "merged" (solo para Pull Requests)

Un cambio de estado en una Discusión / Solicitud de extracción (Pull Request).

Subclase de DiscussionEvent.

clase huggingface_hub.DiscussionCommit

< >

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

Parámetros

  • id (str) — El ID del evento. Una cadena hexadecimal.
  • type (str) — El tipo del evento.
  • created_at (datetime) — Un objeto datetime que contiene la marca de tiempo de creación del evento.
  • author (str) — El nombre de usuario del autor de la Discusión / Solicitud de extracción. Puede ser "deleted" si el usuario ha sido eliminado desde entonces.
  • summary (str) — El resumen del commit.
  • oid (str) — El OID / SHA del commit, como una cadena hexadecimal.

Un commit en una Pull Request.

Subclase de DiscussionEvent.

clase huggingface_hub.DiscussionTitleChange

< >

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

Parámetros

  • id (str) — El ID del evento. Una cadena hexadecimal.
  • type (str) — El tipo del evento.
  • created_at (datetime) — Un objeto datetime que contiene la marca de tiempo de creación del evento.
  • author (str) — El nombre de usuario del autor de la Discusión / Solicitud de extracción. Puede ser "deleted" si el usuario ha sido eliminado desde entonces.
  • old_title (str) — El título anterior de la Discusión / Pull Request.
  • new_title (str) — El nuevo título.

Un evento de cambio de nombre en una Discusión / Solicitud de extracción (Pull Request).

Subclase de DiscussionEvent.

Update on GitHub