Creación de un ejemplo mínimo reproducible para los informes de errores en los repositorios Ultralytics YOLO

Al enviar un informe de error para Ultralytics YOLO repositorios, es esencial proporcionar un Ejemplo Mínimo Reproducible (EMR). Un MRE es un fragmento de código pequeño y autónomo que demuestra el problema que estás experimentando. Proporcionar un MRE ayuda a los mantenedores y colaboradores a entender el problema y a trabajar en una solución de forma más eficiente. Esta guía explica cómo crear un MRE al enviar informes de errores a los repositorios de Ultralytics YOLO .

1. Aísla el problema

El primer paso para crear un MRE es aislar el problema. Elimine cualquier código o dependencia innecesarios que no estén directamente relacionados con el problema. Concéntrese en la parte específica del código que está causando el problema y elimine las secciones irrelevantes.

2. Utilizar modelos y conjuntos de datos públicos

Al crear un MRE, utilice modelos y conjuntos de datos disponibles públicamente para reproducir el problema. Por ejemplo, use el comando yolov8n.pt modelo y el modelo coco8.yaml conjunto de datos. Esto garantiza que los mantenedores y colaboradores puedan ejecutar fácilmente su ejemplo e investigar el problema sin necesidad de acceder a datos propietarios o modelos personalizados.

3. Incluye todas las dependencias necesarias

Asegúrese de que todas las dependencias necesarias estén incluidas en su MRE. Si el código se basa en bibliotecas externas, especifique los paquetes necesarios y sus versiones. Lo ideal es enumerar las dependencias en el informe de errores mediante yolo checks Si tienes ultralytics instalado o pip list para otras herramientas.

4. Escribe una descripción clara del asunto

Proporciona una descripción clara y concisa del problema que estás experimentando. Explica el comportamiento esperado y el comportamiento real que estás encontrando. Si procede, incluye cualquier mensaje de error o registro relevante.

5. Formatea tu código correctamente

Dé formato al código correctamente mediante bloques de código en la descripción del problema. Esto hace que sea más fácil para otros leer y comprender su código. En GitHub, puedes crear un bloque de código envolviendo tu código con acentos graves triples (''') y especificando el idioma:

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

6. Prueba tu MRE

Antes de enviar tu MRE, pruébalo para asegurarte de que reproduce fielmente el problema. Asegúrate de que los demás puedan ejecutar tu ejemplo sin problemas ni modificaciones.

Ejemplo de MRE

Aquí tienes un ejemplo de MRE para un hipotético informe de error:

Descripción del fallo:

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

MRE:

import torch

from ultralytics import YOLO

# Load the model
model = YOLO("yolov8n.pt")

# Load a 0-channel image
image = torch.rand(1, 0, 640, 640)

# Run the model
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.3.0
• ultralytics==8.2.0

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

Si sigues estas directrices, ayudarás a los mantenedores y colaboradores de los repositorios de Ultralytics YOLO a comprender y resolver tu problema con mayor eficacia.

PREGUNTAS FRECUENTES

¿Cómo puedo crear un Ejemplo Mínimo Reproducible (EMR) eficaz para los informes de errores en los repositorios de Ultralytics YOLO ?

Para crear un Ejemplo Mínimo Reproducible (EMR) eficaz para los informes de errores en los repositorios de Ultralytics YOLO , sigue estos pasos:

1. Aísla el problema: Elimina cualquier código o dependencia que no esté directamente relacionado con el problema.
2. Utilizar modelos y conjuntos de datos públicos: Utiliza recursos públicos como yolov8n.pt y coco8.yaml para facilitar la reproducibilidad.
3. Incluye todas las dependencias necesarias: Especifica los paquetes necesarios y sus versiones. Puedes listar las dependencias utilizando yolo checks Si tienes ultralytics instalado o pip list.
4. Escribe una descripción clara del problema: Explica el comportamiento esperado y el real, incluyendo cualquier mensaje de error o registro.
5. Formatea tu código correctamente: Utiliza bloques de código para formatear tu código y facilitar su lectura.
6. Prueba tu MRE: Asegúrate de que tu MRE reproduce el problema sin modificaciones.

Para obtener una guía detallada, consulta Crear un ejemplo mínimo reproducible.

¿Por qué debería utilizar modelos y conjuntos de datos disponibles públicamente en mi MRE para Ultralytics YOLO informes de errores?

Utilizar modelos y conjuntos de datos disponibles públicamente en tu EMR garantiza que los mantenedores puedan ejecutar fácilmente tu ejemplo sin necesidad de acceder a datos propietarios. Esto permite una resolución de problemas más rápida y eficaz. Por ejemplo, si utilizas el yolov8n.pt modelo y coco8.yaml ayuda a normalizar y simplificar el proceso de depuración. Más información sobre modelos y conjuntos de datos públicos en la página Utilizar modelos y conjuntos de datos públicos sección.

¿Qué información debo incluir en mi informe de error para Ultralytics YOLO ?

Un informe completo de errores para Ultralytics YOLO debe incluir:

• Descripción clara: Explica el problema, el comportamiento esperado y el comportamiento real.
• Mensajes de error: Incluye cualquier mensaje de error o registro relevante.
• Dependencias: Lista las dependencias necesarias y sus versiones.
• MRE: Proporciona un Ejemplo Mínimo Reproducible.
• Pasos para reproducir: Esboza los pasos necesarios para reproducir el problema.

Para obtener una lista de comprobación completa, consulta la sección Redacta una descripción clara del asunto.

¿Cómo puedo formatear mi código correctamente al enviar un informe de error en GitHub?

Para formatear correctamente tu código al enviar un informe de error en GitHub:

• Utiliza tres puntos suspensivos (```) para crear bloques de código.
• Especifica el lenguaje de programación para el resaltado sintáctico, por ejemplo, ```python.
• Asegúrate de que tu código tiene la sangría correcta para que sea legible.

Ejemplo:

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

Para más consejos sobre el formato del código, consulta Formatear tu código correctamente.

¿Cuáles son algunos errores comunes que debo comprobar antes de enviar mi MRE para un informe de error?

Antes de enviar tu MRE, asegúrate de:

• Comprueba que el problema es reproducible.
• Asegúrate de que todas las dependencias están enumeradas y son correctas.
• Elimina cualquier código innecesario.
• Prueba el MRE para asegurarte de que reproduce el problema sin modificaciones.

Para obtener una lista de comprobación detallada, visita la sección Pon a prueba tu MRE.

Comentarios