Créer un exemple minimal reproductible pour les rapports de bug#

Lorsque tu soumets un rapport de bug pour les dépôts Ultralytics YOLO, il est essentiel de fournir un Minimum Reproducible Example (MRE). Un MRE est un petit morceau de code autonome qui démontre le problème que tu rencontres. Fournir un MRE aide les mainteneurs et les contributeurs à comprendre le problème et à travailler sur un correctif plus efficacement. Ce guide explique comment créer un MRE lors de la soumission de rapports de bug aux dépôts Ultralytics YOLO.

1. Isoler le problème#

La première étape pour créer un MRE consiste à isoler le problème. Supprime tout code ou dépendance inutile qui n'est pas directement lié au problème. Concentre-toi sur la partie spécifique du code qui cause le problème et élimine toute section non pertinente.

2. Utiliser des modèles et des jeux de données publics#

Lors de la création d'un MRE, utilise des modèles et des jeux de données publiquement disponibles pour reproduire le problème. Par exemple, utilise le modèle yolo26n.pt et le jeu de données coco8.yaml. Cela garantit que les mainteneurs et les contributeurs peuvent facilement exécuter ton exemple et enquêter sur le problème sans avoir besoin d'accéder à des données propriétaires ou à des modèles personnalisés.

3. Inclure toutes les dépendances nécessaires#

Assure-toi que toutes les dépendances nécessaires sont incluses dans ton MRE. Si ton code dépend de bibliothèques externes, spécifie les paquets requis et leurs versions. Idéalement, liste les dépendances dans ton rapport de bug en utilisant yolo checks si tu as ultralytics installé ou pip list pour d'autres outils.

4. Rédiger une description claire du problème#

Fournis une description claire et concise du problème que tu rencontres. Explique le comportement attendu et le comportement réel auquel tu es confronté. Si applicable, inclus tout message d'erreur ou journal pertinent.

5. Formater correctement ton code#

Formate correctement ton code en utilisant des blocs de code dans la description du problème. Cela permet aux autres de lire et de comprendre plus facilement ton code. Sur GitHub, tu peux créer un bloc de code en entourant ton code avec trois backticks (```) et en précisant le langage :

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

6. Tester ton MRE#

Avant de soumettre ton MRE, teste-le pour t'assurer qu'il reproduit fidèlement le problème. Assure-toi que les autres peuvent exécuter ton exemple sans aucun problème ni modification.

Exemple d'un MRE#

Voici un exemple de MRE pour un rapport de bug hypothétique :

Description du bug :

Lors de l'exécution d'une inférence sur une image à 0 canal, je reçois une erreur liée aux dimensions du tenseur d'entrée.

MRE :

import torch

from ultralytics import YOLO

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

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

# Run the model
results = model(image)

Message d'erreur :

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

Dépendances :

• torch==2.3.0
• ultralytics==8.2.0

Dans cet exemple, le MRE démontre le problème avec un minimum de code, utilise un modèle public ("yolo26n.pt"), inclut toutes les dépendances nécessaires et fournit une description claire du problème ainsi que le message d'erreur.

En suivant ces directives, tu aideras les mainteneurs et les contributeurs des dépôts Ultralytics YOLO à comprendre et à résoudre ton problème plus efficacement.

FAQ#