YOLOv5 con Comet#

En esta guía aprenderás a usar YOLOv5 con Comet, una herramienta potente para realizar el seguimiento, comparar y optimizar experimentos de machine learning.

Acerca de Comet#

Comet crea herramientas que ayudan a científicos de datos, ingenieros y responsables de equipos a acelerar y optimizar modelos de machine learning y deep learning.

Realiza un seguimiento y visualiza las métricas del modelo en tiempo real, guarda tus hiperparámetros, conjuntos de datos y checkpoints del modelo, y visualiza las predicciones de tu modelo con los paneles personalizados de Comet. ¡Comet garantiza que nunca pierdas el control de tu trabajo y facilita compartir resultados y colaborar entre equipos de cualquier tamaño!

Primeros pasos#

Instalar Comet#

pip install comet_ml

Configurar las credenciales de Comet#

Hay dos formas de configurar Comet con YOLOv5.

Puedes configurar tus credenciales mediante variables de entorno:

Variables de entorno

export COMET_API_KEY=YOUR_API_KEY
export COMET_PROJECT_NAME=YOUR_COMET_PROJECT_NAME # This will default to 'yolov5'

También puedes crear un archivo .comet.config en tu directorio de trabajo y configurar allí tus credenciales:

Archivo de configuración de Comet

[comet]
api_key=YOUR_API_KEY
project_name=YOUR_COMET_PROJECT_NAME # This will default to 'yolov5'

Ejecutar el script de entrenamiento#

# Train YOLOv5s on COCO128 for 5 epochs
python train.py --img 640 --batch 16 --epochs 5 --data coco128.yaml --weights yolov5s.pt

¡Eso es todo! Comet registrará automáticamente tus hiperparámetros, argumentos de la línea de comandos y métricas de entrenamiento y validación. Puedes visualizar y analizar tus ejecuciones en la interfaz de usuario de Comet.

¡Prueba un ejemplo!#

Consulta aquí un ejemplo de una ejecución completada.

O, mejor aún, pruébalo tú mismo en este cuaderno de Colab:

Registrar automáticamente#

De forma predeterminada, Comet registrará los siguientes elementos:

Métricas#

• Pérdida de cajas, pérdida de objetos y pérdida de clasificación para los datos de validación
• Métricas mAP_0.5 y mAP_0.5:0.95 para los datos de validación
• Precisión y exhaustividad para los datos de validación

Parámetros#

• Hiperparámetros del modelo
• Todos los parámetros pasados mediante las opciones de la línea de comandos

Visualizaciones#

• Matriz de confusión de las predicciones del modelo sobre los datos de validación
• Gráficos de las curvas PR y F1 para todas las clases
• Correlograma de las etiquetas de clase

Configurar el registro de Comet#

Puedes configurar Comet para que registre datos adicionales mediante indicadores de la línea de comandos pasados al script de entrenamiento o mediante variables de entorno:

export COMET_MODE=online                           # Set whether to run Comet in 'online' or 'offline' mode. Defaults to online
export COMET_MODEL_NAME="yolov5"                   # Set the name for the saved model. Defaults to yolov5
export COMET_LOG_CONFUSION_MATRIX=false            # Set to disable logging a Comet Confusion Matrix. Defaults to true
export COMET_MAX_IMAGE_UPLOADS=30                  # Controls how many total image predictions to log to Comet. Defaults to 100.
export COMET_LOG_PER_CLASS_METRICS=true            # Set to log evaluation metrics for each detected class at the end of training. Defaults to false
export COMET_DEFAULT_CHECKPOINT_FILENAME="last.pt" # Set this if you would like to resume training from a different checkpoint. Defaults to 'last.pt'
export COMET_LOG_BATCH_LEVEL_METRICS=true          # Set this if you would like to log training metrics at the batch level. Defaults to false.
export COMET_LOG_PREDICTIONS=true                  # Set this to false to disable logging model predictions

Registrar checkpoints con Comet#

El registro de modelos en Comet está desactivado de forma predeterminada. Para activarlo, pasa el argumento save-period al script de entrenamiento. Esto guardará los checkpoints registrados en Comet según el valor de intervalo proporcionado por save-period:

python train.py \
  --img 640 \
  --batch 16 \
  --epochs 5 \
  --data coco128.yaml \
  --weights yolov5s.pt \
  --save-period 1

Registrar las predicciones del modelo#

De forma predeterminada, las predicciones del modelo (imágenes, etiquetas de verdad terreno y cuadros delimitadores) se registrarán en Comet.

Puedes controlar la frecuencia de las predicciones registradas y de las imágenes asociadas pasando el argumento de la línea de comandos bbox_interval. Las predicciones se pueden visualizar mediante el panel personalizado de detección de objetos de Comet. Esta frecuencia corresponde a cada N.º lote de datos por época. En el ejemplo siguiente, registramos cada 2.º lote de datos de cada época.

Nota: El cargador de datos de validación de YOLOv5 utilizará de forma predeterminada un tamaño de lote de 32, por lo que tendrás que configurar la frecuencia de registro en consecuencia.

Aquí tienes un proyecto de ejemplo que utiliza el panel

python train.py \
  --img 640 \
  --batch 16 \
  --epochs 5 \
  --data coco128.yaml \
  --weights yolov5s.pt \
  --bbox_interval 2

Controlar el número de imágenes de predicciones registradas en Comet#

Al registrar predicciones de YOLOv5, Comet registrará las imágenes asociadas a cada conjunto de predicciones. De forma predeterminada, se registra un máximo de 100 imágenes de validación. Puedes aumentar o reducir este número mediante la variable de entorno COMET_MAX_IMAGE_UPLOADS:

env COMET_MAX_IMAGE_UPLOADS=200 python train.py \
  --img 640 \
  --batch 16 \
  --epochs 5 \
  --data coco128.yaml \
  --weights yolov5s.pt \
  --bbox_interval 1

Registrar métricas por clase#

Usa la variable de entorno COMET_LOG_PER_CLASS_METRICS para registrar mAP, precisión, exhaustividad y f1 de cada clase:

env COMET_LOG_PER_CLASS_METRICS=true python train.py \
  --img 640 \
  --batch 16 \
  --epochs 5 \
  --data coco128.yaml \
  --weights yolov5s.pt

Subir un conjunto de datos a los artefactos de Comet#

Si quieres almacenar tus datos mediante Comet Artifacts, puedes hacerlo usando el indicador upload_dataset.

El conjunto de datos debe estar organizado tal como se describe en la documentación de YOLOv5. El archivo de configuración del conjunto de datos yaml debe seguir el mismo formato que el archivo coco128.yaml.

python train.py \
  --img 640 \
  --batch 16 \
  --epochs 5 \
  --data coco128.yaml \
  --weights yolov5s.pt \
  --upload_dataset

Puedes encontrar el conjunto de datos subido en la pestaña Artifacts de tu espacio de trabajo de Comet:

Puedes previsualizar los datos directamente en la interfaz de usuario de Comet:

Los artefactos tienen versiones y también permiten añadir metadatos sobre el conjunto de datos. Comet registrará automáticamente los metadatos del archivo yaml de tu conjunto de datos:

Usar un artefacto guardado#

Si quieres usar un conjunto de datos de Comet Artifacts, establece la variable path en el archivo yaml de tu conjunto de datos para que apunte a la siguiente URL del recurso Artifact:

# Contents of artifact.yaml file
path: "comet://WORKSPACE_NAME/ARTIFACT_NAME:ARTIFACT_VERSION_OR_ALIAS"

Después, pasa este archivo al script de entrenamiento de la siguiente forma:

python train.py \
  --img 640 \
  --batch 16 \
  --epochs 5 \
  --data artifact.yaml \
  --weights yolov5s.pt

Los artefactos también permiten realizar un seguimiento del linaje de los datos a medida que fluyen por tu flujo de trabajo de experimentación. Aquí puedes ver un grafo que muestra todos los experimentos que han utilizado tu conjunto de datos subido:

Reanudar una ejecución de entrenamiento#

Si tu ejecución de entrenamiento se interrumpe por cualquier motivo, por ejemplo, debido a una conexión a Internet interrumpida, puedes reanudarla usando el indicador resume y la ruta de ejecución de Comet.

La ruta de ejecución tiene el siguiente formato: comet://WORKSPACE_NAME/PROJECT_NAME/EXPERIMENT_ID.

Esto restaurará la ejecución al estado anterior a la interrupción, lo que incluye restaurar el modelo desde un checkpoint, restaurar todos los hiperparámetros y argumentos de entrenamiento, y descargar los artefactos del conjunto de datos de Comet si se utilizaron en la ejecución original. La ejecución reanudada continuará registrándose en el experimento existente en la interfaz de usuario de Comet:

python train.py \
  --resume "comet://YOUR_RUN_PATH"

Búsqueda de hiperparámetros con el optimizador de Comet#

YOLOv5 también está integrado con el optimizador de Comet, lo que facilita visualizar los barridos de hiperparámetros en la interfaz de usuario de Comet.

Configurar un barrido del optimizador#

Para configurar el optimizador de Comet, tendrás que crear un archivo JSON con la información del barrido. Se proporciona un archivo de ejemplo en utils/loggers/comet/optimizer_config.json:

python utils/loggers/comet/hpo.py \
  --comet_optimizer_config "utils/loggers/comet/optimizer_config.json"

El script hpo.py acepta los mismos argumentos que train.py. Si quieres pasar argumentos adicionales a tu barrido, simplemente añádelos después del script:

python utils/loggers/comet/hpo.py \
  --comet_optimizer_config "utils/loggers/comet/optimizer_config.json" \
  --save-period 1 \
  --bbox_interval 1

Visualizar los resultados#

Comet ofrece varias formas de visualizar los resultados de tu barrido. Echa un vistazo a un proyecto con un barrido completado aquí.