course/pr_1213/es/chapter4/4.md

# Crear una tarjeta del modelo[[building-a-model-card]]

La tarjeta del modelo es un archivo que, posiblemente, es tan importante como los archivos del modelo y del tokenizador dentro de un repositorio de modelos. Es la definición central del modelo: garantiza que otros miembros de la comunidad puedan reutilizarlo y reproducir resultados, y ofrece una base sobre la cual otras personas pueden construir sus propios artefactos.

Documentar el proceso de entrenamiento y evaluación ayuda a otras personas a entender qué pueden esperar de un modelo. Y proporcionar suficiente información sobre los datos usados, así como sobre el preprocesamiento y posprocesamiento realizados, asegura que se puedan identificar y comprender las limitaciones, sesgos y contextos en los que el modelo es o no es útil.

Por eso, crear una tarjeta del modelo que defina con claridad tu modelo es un paso muy importante. Aquí te damos algunos consejos que pueden ayudarte. La tarjeta del modelo se crea a través del archivo *README.md* que viste antes, que es un archivo Markdown.

El concepto de "tarjeta del modelo" proviene de una línea de investigación de Google, compartida por primera vez en el artículo ["Model Cards for Model Reporting"](https://arxiv.org/abs/1810.03993) de Margaret Mitchell et al. Gran parte de la información contenida aquí se basa en ese artículo, y te recomendamos revisarlo para entender por qué las tarjetas del modelo son tan importantes en un mundo que valora la reproducibilidad, la reutilización y la equidad.

La tarjeta del modelo suele comenzar con una visión general muy breve y de alto nivel de para qué sirve el modelo, seguida de detalles adicionales en las secciones siguientes:

- Descripción del modelo
- Usos previstos y limitaciones
- Cómo usarlo
- Limitaciones y sesgos
- Datos de entrenamiento
- Procedimiento de entrenamiento
- Resultados de evaluación

Veamos qué debería contener cada una de estas secciones.

### Descripción del modelo[[model-description]]

La descripción del modelo ofrece detalles básicos sobre el modelo. Esto incluye la arquitectura, la versión, si se presentó en un artículo, si existe una implementación original disponible, la autoría e información general sobre el modelo. Cualquier información de copyright debe atribuirse aquí. También puede mencionarse en esta sección información general sobre los procedimientos de entrenamiento, parámetros y advertencias importantes.

### Usos previstos y limitaciones[[intended-uses-limitations]]

Aquí describes los casos de uso para los que el modelo está pensado, incluyendo los idiomas, campos y dominios en los que puede aplicarse. Esta sección de la tarjeta del modelo también puede documentar áreas que se sabe que quedan fuera de alcance para el modelo, o donde es probable que rinda por debajo de lo esperado.

### Cómo usarlo[[how-to-use]]

Esta sección debería incluir algunos ejemplos de cómo usar el modelo. Puede mostrar el uso de la función `pipeline()`, el uso de las clases del modelo y del tokenizador, y cualquier otro fragmento de código que consideres útil.

### Datos de entrenamiento[[training-data]]

Esta parte debería indicar con qué dataset(s) se entrenó el modelo. También es bienvenida una breve descripción de esos datasets.

### Procedimiento de entrenamiento[[training-procedure]]

En esta sección deberías describir todos los aspectos relevantes del entrenamiento desde la perspectiva de la reproducibilidad. Eso incluye cualquier preprocesamiento y posprocesamiento realizado sobre los datos, así como detalles como el número de épocas con las que se entrenó el modelo, el tamaño del lote, la tasa de aprendizaje, etc.

### Variables y métricas[[variable-and-metrics]]

Aquí deberías describir las métricas que usas para la evaluación y los distintos factores que estás midiendo. Mencionar qué métrica(s) se usaron, sobre qué dataset y sobre qué partición del dataset facilita comparar el rendimiento de tu modelo con el de otros modelos. Todo esto debería estar informado por secciones anteriores, como los usuarios previstos y los casos de uso.

### Resultados de evaluación[[evaluation-results]]

Por último, indica qué tan bien rinde el modelo en el dataset de evaluación. Si el modelo usa un umbral de decisión, proporciona ese umbral empleado en la evaluación o da detalles sobre la evaluación con distintos umbrales según los usos previstos.

## Ejemplo[[example]]

Mira los siguientes ejemplos de tarjetas del modelo bien elaboradas:

- [`bert-base-cased`](https://huggingface.co/bert-base-cased)
- [`gpt2`](https://huggingface.co/gpt2)
- [`distilbert`](https://huggingface.co/distilbert-base-uncased)

Puedes encontrar más ejemplos de distintas organizaciones y empresas [aquí](https://github.com/huggingface/model_card/blob/master/examples.md).

## Nota[[note]]

Las tarjetas del modelo no son un requisito al publicar modelos y no necesitas incluir todas las secciones descritas antes cuando crees una. Sin embargo, la documentación explícita del modelo solo puede beneficiar a quienes lo usen en el futuro, así que te recomendamos completar tantas secciones como sea posible según tu conocimiento y posibilidades.

## Metadatos de la tarjeta del modelo[[model-card-metadata]]

Si has explorado un poco el Hugging Face Hub, habrás visto que algunos modelos pertenecen a determinadas categorías: puedes filtrarlos por tareas, idiomas, librerías y más. Las categorías a las que pertenece un modelo se identifican según los metadatos que añadas en la cabecera de la tarjeta del modelo.

Por ejemplo, si miras la [tarjeta del modelo de `camembert-base`](https://huggingface.co/camembert-base/blob/main/README.md), deberías ver las siguientes líneas en la cabecera:

```
---
language: fr
license: mit
datasets:
- oscar
---
```

El Hugging Face Hub interpreta esos metadatos y así identifica este modelo como un modelo en francés, con licencia MIT y entrenado sobre el dataset Oscar.

La [especificación completa de la tarjeta del modelo](https://github.com/huggingface/hub-docs/blame/main/modelcard.md) permite indicar idiomas, licencias, etiquetas, datasets, métricas, así como los resultados de evaluación que obtuvo el modelo durante el entrenamiento.