Hub documentation

Lista de verificación para la publicación de modelo(s)

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Lista de verificación para la publicación de modelo(s)

El Hugging Face Hub es la plataforma de referencia para compartir modelos de aprendizaje automático. Una publicación bien ejecutada puede aumentar la visibilidad y el impacto de tu modelo. Esta sección cubre los pasos esenciales para una publicación de modelo concisa, informativa y fácil de usar.

¿Publicando con un agente de código? Instala la hf CLI Skill para que tu agente gestione la carga, la tarjeta del modelo y los metadatos por ti.

⏳ Preparando tu modelo para su lanzamiento

Subir los pesos del modelo

Al subir modelos al Hub, siga estas mejores prácticas:

  • Usa repositorios separados para diferentes pesos de modelos: Crea repositorios individuales para cada variante de la misma arquitectura. Esto te permite agruparlos en una colección, que es más fácil de navegar que las listas de directorios. También mejora la visibilidad porque cada modelo tiene su propia URL (hf.co/org/model-name), facilita la búsqueda y proporciona recuentos de descargas para cada uno de tus modelos. Un gran ejemplo es la reciente colección Qwen3-VL, que presenta diversas variantes de la arquitectura VL.

  • Prefer safetensors over pickle for weight serialization.: safetensors es más seguro y rápido que pickle o pth de Python. Si tienes un archivo pickle .bin, usa la herramienta de conversión de pesos para convertirlo.

Escribir una tarjeta de modelo exhaustiva

Una tarjeta de modelo bien elaborada (el README.md de tu repositorio) es esencial para la descubribilidad, la reproducibilidad y el intercambio efectivo. Asegúrate de cubrir:

  1. Configuración de metadatos: La sección de metadatos (YAML) en la parte superior de la tarjeta de tu modelo es clave para la búsqueda y la categorización. Incluye:

    ---
    pipeline_tag: text-generation    # Specify the task
    library_name: transformers       # Specify the library
    language:
      - en                           # List languages your model supports
    license: apache-2.0              # Specify a license
    datasets:
      - username/dataset             # List datasets used for training
    base_model: username/base-model  # If applicable (your model is a fine-tune, quantized, merged version of another model)
    tags:                            # Add extra tags which would make the repo searchable using the tag
      - tag1 
      - tag2
    ---

    Si creas el README.md en la interfaz web, verás un formulario con los campos de metadatos más importantes que recomendamos 🤗.

    metadata template on the hub ui
    Formulario de metadatos en la interfaz de usuario del Hub
  2. Descripción detallada del modelo: Proporciona una explicación clara de lo que hace tu modelo, su arquitectura y sus casos de uso previstos. Ayuda a los usuarios a decidir rápidamente si se adapta a sus necesidades.

  3. Ejemplos de uso: Proporciona fragmentos de código claros, listos para copiar y ejecutar, para inferencia, ajuste fino u otras tareas comunes. Minimiza las ediciones necesarias por parte de los usuarios.

    Bonus: Añade un notebook.ipynb bien estructurado en el repositorio que muestre inferencia o ajuste fino, para que los usuarios puedan abrirlo directamente en Google Colab y Kaggle Notebooks.

    colab and kaggle button
    Botones de uso de Google y Kaggle
  4. Especificaciones técnicas: Incluya los parámetros de entrenamiento, los requisitos de hardware y otros detalles que ayuden a los usuarios a ejecutar el modelo de manera efectiva.

  5. Métricas de rendimiento: Comparta benchmarks y resultados de evaluación. Incluya métricas cuantitativas y ejemplos cualitativos para mostrar fortalezas y limitaciones.

  6. Limitaciones y sesgos: Documenta las limitaciones, los sesgos y las consideraciones éticas conocidas para que los usuarios puedan tomar decisiones informadas.

Para hacer el proceso más fluido, haz clic en Import model card template para rellenar los README.md con marcadores de posición.

model card template button on the hub uimodel card template on the hub
El botón para importar la plantilla de la tarjeta del modeloUna sección de la plantilla importada

Mejorar la descubribilidad y la usabilidad de los modelos

Para maximizar el alcance y la usabilidad:

  1. Integración de librerías: Añade soporte para una de las muchas librerías integradas con el Hugging Face Hub (como transformers, diffusers, sentence-transformers, timm). Esta integración aumenta significativamente la accesibilidad de tu modelo y proporciona a los usuarios fragmentos de código para trabajar con él.

    Por ejemplo, para especificar que tu modelo funciona con la biblioteca transformers:

    ---
    library_name: transformers
    ---
    code snippet tab
    Pestaña de fragmento de código

    También puedes registrar tu propia biblioteca de modelos o añadir soporte de Hub a tu biblioteca y base de código, para que los usuarios sepan cómo descargar los pesos de los modelos desde el Hub.

    Escribimos una guía exhaustiva sobre las mejores prácticas para subir archivos aquí.

    El uso de una biblioteca registrada también le permite hacer un seguimiento de las descargas de su modelo a lo largo del tiempo.

  2. Metadatos correctos:

    • Etiqueta de pipeline: Elige la etiqueta de pipeline correcta para que tu modelo aparezca en las búsquedas y widgets adecuados.

    Ejemplos de etiquetas de pipeline comunes:

    • text-generation - Para modelos de lenguaje que generan texto

    • text-to-image - Para modelos de generación de texto a imagen

    • image-text-to-text - Para modelos de visión-lenguaje (VLM) que generan texto

    • text-to-speech - Para modelos que generan audio a partir de texto

    • Licencia: La información de la licencia es crucial para que los usuarios comprendan cómo pueden utilizar el modelo.

  3. Artículos de investigación: Si su modelo tiene artículos asociados, cítelos en la tarjeta del modelo. Se enlazarán automáticamente.

    ## References
    
    * [Model Paper](https://arxiv.org/abs/xxxx.xxxxx)
  4. Colecciones: Si vas a publicar varios modelos o variantes relacionados, organízalos en una colección. Las colecciones ayudan a los usuarios a descubrir modelos relacionados y a comprender las relaciones entre versiones.

  5. Demos: Crea un Hugging Face Space con una demo interactiva. Esto permite a los usuarios probar tu modelo sin escribir código. También puedes enlazar el modelo desde el Space para que aparezca en la interfaz de la página del modelo.

    ## Demo
    
    Try this model directly in your browser: [Space Demo](https://huggingface.co/spaces/username/model-demo)

    Cuando creas una demo, descarga el modelo desde su repositorio en Hub (no desde fuentes externas como Google Drive). Esto crea enlaces cruzados entre los artefactos y mejora la visibilidad

  6. Versiones cuantizadas: Considere subir versiones cuantizadas (por ejemplo, GGUF) en un repositorio separado para mejorar la accesibilidad para usuarios con recursos de cómputo limitados. Enlaze estas versiones utilizando el campo de metadatos base_model en las tarjetas de los modelos cuantizados y documente las diferencias de rendimiento.

    ---
    base_model: username/original-model
    base_model_relation: quantized
    ---
    model tree showcasing relations
    Árbol de modelos que muestra las versiones cuantizadas
  7. Vincular conjuntos de datos en la página del modelo: Vincula los conjuntos de datos en tus metadatos para que aparezcan directamente en la página de tu modelo.

    ---
    datasets:
    - username/dataset
    - username/dataset-2
    ---
  8. Nueva versión del modelo: Si tu modelo es una actualización de uno existente, indícalo en la tarjeta del modelo anterior. Esto mostrará un banner en la página anterior que enlaza con la actualización.

    ---
    new_version: username/updated-model
    ---
  9. Ejemplos visuales: Para modelos de generación de imágenes o videos, incluye ejemplos directamente en tu página de modelo usando el componente de tarjeta <Gallery>.

    <Gallery>
    ![Example 1](./images/example1.png)
    ![Example 2](./images/example2.png)
    </Gallery>
  10. Emisiones de carbono: Si es posible, especifique las emisiones de carbono del entrenamiento.

    ---
    co2_eq_emissions:
      emissions: 123.45
      source: "CodeCarbon"
      training_type: "pre-training"
      geographical_location: "US-East"
      hardware_used: "8xA100 GPUs"
    ---

Control de acceso y visibilidad

  1. Configuración de visibilidad: Cuando estés listo para compartir tu modelo, cámbialo a público en tu configuración del modelo. Antes de hacerlo, verifica que toda la documentación y los ejemplos de código sean precisos y completos.

  2. Acceso restringido: Si su modelo requiere un acceso controlado, utilice la función de acceso restringido y especifique claramente las condiciones que deben cumplir los usuarios. Esto es importante para modelos con preocupaciones de doble uso o restricciones comerciales.

🏁 Después de publicar tu modelo

Una publicación exitosa de un modelo va más allá de la publicación inicial. Para mantener la calidad y maximizar el impacto:

Mantenimiento y participación de la comunidad

  1. Verificar la funcionalidad: Después del lanzamiento, prueba todos los fragmentos de código en un entorno limpio para confirmar que funcionan como se espera. Esto garantiza que los usuarios puedan ejecutar tu modelo sin errores ni confusiones.

    Por ejemplo, si tu modelo es un LLM compatible con transformers:

    from transformers import pipeline
    
    # This should run without errors
    pipe = pipeline("text-generation", model="your-username/your-model")
    result = pipe("Your test prompt")
    print(result)
  2. Compartir Compartir Compartir: La mayoría de los usuarios descubre modelos a través de redes sociales, canales de chat (como Slack o Discord) o boletines. Comparte los enlaces de tu modelo en estos espacios y también añádelos a tu sitio web o repositorios de GitHub.

    Cuantas más visitas y me gusta reciba tu modelo, más alto aparecerá en la sección de Tendencias de Hugging Face, lo que le otorgará aún más visibilidad

  3. Interacción con la comunidad: Utiliza la pestaña Comunidad para responder preguntas, atender comentarios y resolver problemas de forma rápida. Aclara dudas, acepta sugerencias útiles y cierra hilos fuera de tema para mantener las discusiones centradas.

Agregar resultados de evaluación

Si evalúas en alguno de los conjuntos de datos de referencia compatibles en el Hub, puedes añadir los resultados de la evaluación a tu repositorio de modelos. Esto hará que las puntuaciones de referencia sean visibles directamente en la página del modelo y en la tabla de clasificación de referencia del repositorio del conjunto de datos. Consulta la documentación de Resultados de evaluación para la especificación completa.

Para agregar resultados de evaluación, cree archivos YAML en la carpeta .eval_results/ de su repositorio de modelos. Cada archivo hace referencia a un conjunto de datos de Hub Benchmark:

# .eval_results/gpqa.yaml
- dataset:
    id: Idavidrein/gpqa
    task_id: diamond
  value: 76.1
  date: "2026-03-19"
  source:
    url: https://huggingface.co/your-org/your-model
    name: Model Card
    user: your-username

El task_id debe coincidir con una tarea definida en el eval.yaml del conjunto de datos del benchmark. Puede encontrar los benchmarks disponibles y sus IDs de tarea consultando el archivo eval.yaml en los repositorios de conjuntos de datos de benchmarks como HLE.

Cualquier persona de la comunidad también puede enviar resultados de evaluación para cualquier modelo abriendo una Pull Request. Las puntuaciones enviadas por la comunidad muestran una insignia de “community” en la página del modelo. Para agilizar este proceso, puedes usar el repositorio community-evals, que proporciona scripts y una habilidad de agente para extraer puntuaciones de las tarjetas de modelos y crear PR de forma automática.

Seguimiento del uso y el impacto

  1. Métricas de uso: Seguimiento de descargas y me gusta para comprender el alcance y la adopción de tu modelo. Puedes ver las métricas totales de descargas en la configuración de tu modelo.

  2. Revisar las contribuciones de la comunidad: Revisa periódicamente el repositorio de tu modelo para ver las contribuciones de otros usuarios. Las solicitudes de extracción y las discusiones de la comunidad pueden proporcionar comentarios útiles, ideas y oportunidades de colaboración.

🏢 Funciones empresariales

La suscripción Hugging Face Team & Enterprise ofrece capacidades adicionales para equipos y organizaciones:

  1. Control de acceso: Configura grupos de recursos para gestionar el acceso de equipos o usuarios específicos. Esto garantiza los permisos adecuados y una colaboración segura en toda tu organización.

  2. Región de almacenamiento: Elija la región de almacenamiento de datos (EE. UU. o UE) para sus archivos de modelo y cumplir con las regulaciones y requisitos de cumplimiento de datos regionales.

  3. Analítica avanzada: Utilice Publisher Analytics para obtener información más detallada sobre los patrones de uso de los modelos, las descargas y las tendencias de adopción en toda su organización.

  4. Almacenamiento extendido: Acceda a una capacidad de almacenamiento privado adicional para alojar más modelos y artefactos más grandes a medida que su cartera de modelos se expanda.

  5. Publicaciones de blog de la organización: Las organizaciones empresariales ahora pueden publicar artículos de blog directamente en Hugging Face. Esto les permite compartir lanzamientos de modelos, actualizaciones de investigación y anuncios con la comunidad en general, todo desde el perfil de su organización.

Al seguir estas pautas y ejemplos, harás que la publicación de tu modelo en Hugging Face sea clara, útil e impactante. Esto ayuda a que tu trabajo llegue a más personas, fortalece la comunidad de IA y aumenta la visibilidad de tu modelo.

¡No podemos esperar a ver lo que compartas a continuación! 🤗

Update on GitHub