Cómo crear un ejemplo mínimo reproducible para informar de errores#

Al informar de un error en los repositorios de Ultralytics YOLO, es fundamental proporcionar un ejemplo mínimo reproducible (MRE). Un MRE es un fragmento de código pequeño y autónomo que muestra el problema que tienes. Proporcionar un MRE ayuda a los responsables del mantenimiento y a los colaboradores a comprender el problema y resolverlo con mayor eficacia. Esta guía explica cómo crear un MRE al informar de errores en los repositorios de Ultralytics YOLO.

1. Aísla el problema#

El primer paso para crear un MRE es aislar el problema. Elimina el código y las dependencias innecesarios que no estén directamente relacionados con el problema. Céntrate en la parte concreta del código que lo causa y elimina las secciones irrelevantes.

2. Utiliza modelos y conjuntos de datos públicos#

Al crear un MRE, utiliza modelos y conjuntos de datos disponibles públicamente para reproducir el problema. Por ejemplo, utiliza el modelo yolo26n.pt y el conjunto de datos coco8.yaml. Así, los responsables del mantenimiento y los colaboradores podrán ejecutar fácilmente tu ejemplo e investigar el problema sin necesitar acceso a datos propietarios ni a modelos personalizados.

3. Incluye todas las dependencias necesarias#

Asegúrate de incluir en el MRE todas las dependencias necesarias. Si tu código depende de bibliotecas externas, especifica los paquetes necesarios y sus versiones. Lo ideal es enumerar las dependencias en el informe del error mediante yolo checks si tienes instalado ultralytics, o mediante pip list para otras herramientas.

4. Describe el problema con claridad#

Describe de forma clara y concisa el problema que tienes. Explica cuál debería ser el comportamiento y cuál es el comportamiento real que observas. Si procede, incluye los mensajes de error o registros pertinentes.

5. Da el formato adecuado al código#

Da el formato adecuado al código con bloques de código en la descripción del problema. Así será más fácil que otras personas lean y entiendan tu código. En GitHub, puedes crear un bloque de código encerrándolo entre tres acentos graves (```) e indicando el lenguaje:

```python
# Your Python code goes here
```

6. Prueba el MRE#

Antes de enviar el MRE, pruébalo para asegurarte de que reproduce fielmente el problema. Comprueba que otras personas puedan ejecutar tu ejemplo sin problemas ni modificaciones.

Ejemplo de MRE#

Este es un ejemplo de MRE para un informe de error hipotético:

Descripción del error:

Al ejecutar la inferencia en una imagen con 0 canales, aparece un error relacionado con las dimensiones del tensor de entrada.

MRE:

import torch

from ultralytics import YOLO

# Carga el modelo
model = YOLO("yolo26n.pt")

# Carga una imagen con 0 canales
image = torch.rand(1, 0, 640, 640)

# Ejecuta el modelo
results = model(image)

Mensaje de error:

RuntimeError: Expected input[1, 0, 640, 640] to have 3 channels, but got 0 channels instead

Dependencias:

• torch==2.8.0
• ultralytics==8.4.142

En este ejemplo, el MRE muestra el problema con una cantidad mínima de código, utiliza un modelo público ("yolo26n.pt"), incluye todas las dependencias necesarias y describe claramente el problema junto con el mensaje de error.

Si sigues estas pautas, ayudarás a los responsables del mantenimiento y a los colaboradores de los repositorios de Ultralytics YOLO a comprender y resolver tu problema con mayor eficacia.

Preguntas frecuentes#