Ein minimales reproduzierbares Beispiel für Fehlerberichte erstellen#

Wenn du einen Fehler in Ultralytics-YOLO-Repositories meldest, solltest du unbedingt ein minimales reproduzierbares Beispiel (MRE) bereitstellen. Ein MRE ist ein kleiner, eigenständiger Codeausschnitt, der das auftretende Problem veranschaulicht. Ein MRE hilft den Maintainerinnen und Maintainer sowie den Beitragenden, das Problem zu verstehen und effizienter an einer Lösung zu arbeiten. Diese Anleitung erklärt, wie du beim Melden von Fehlern in Ultralytics-YOLO-Repositories ein MRE erstellst.

1. Problem eingrenzen#

Der erste Schritt beim Erstellen eines MRE besteht darin, das Problem einzugrenzen. Entferne unnötigen Code und Abhängigkeiten, die nicht unmittelbar mit dem Problem zusammenhängen. Konzentriere dich auf den konkreten Codeabschnitt, der das Problem verursacht, und entferne alle irrelevanten Teile.

2. Öffentliche Modelle und Datensätze verwenden#

Verwende beim Erstellen eines MRE öffentlich verfügbare Modelle und Datensätze, um das Problem nachzustellen. Verwende zum Beispiel das Modell yolo26n.pt und den Datensatz coco8.yaml. So können Maintainerinnen und Maintainer sowie Beitragende dein Beispiel problemlos ausführen und das Problem untersuchen, ohne Zugriff auf proprietäre Daten oder benutzerdefinierte Modelle zu benötigen.

3. Alle erforderlichen Abhängigkeiten angeben#

Stelle sicher, dass dein MRE alle erforderlichen Abhängigkeiten enthält. Wenn dein Code auf externe Bibliotheken angewiesen ist, gib die benötigten Pakete und deren Versionen an. Führe die Abhängigkeiten in deinem Fehlerbericht idealerweise mit yolo checks auf, wenn ultralytics installiert ist, oder mit pip list für andere Tools.

4. Das Problem klar beschreiben#

Beschreibe das auftretende Problem klar und prägnant. Erläutere das erwartete und das tatsächlich beobachtete Verhalten. Füge gegebenenfalls relevante Fehlermeldungen oder Protokolle hinzu.

5. Code richtig formatieren#

Formatiere deinen Code in der Problembeschreibung mithilfe von Codeblöcken. So können andere deinen Code leichter lesen und verstehen. In GitHub kannst du einen Codeblock erstellen, indem du deinen Code in dreifache Backticks (```) einschließt und die Sprache angibst:

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

6. MRE testen#

Teste dein MRE vor dem Einreichen, um sicherzustellen, dass es das Problem genau reproduziert. Vergewissere dich, dass andere dein Beispiel ohne Probleme oder Änderungen ausführen können.

Beispiel für ein MRE#

Hier ist ein Beispiel für ein MRE zu einem hypothetischen Fehlerbericht:

Fehlerbeschreibung:

Beim Ausführen der Inferenz auf einem Bild mit 0 Kanälen erhalte ich einen Fehler im Zusammenhang mit den Dimensionen des Eingabetensors.

MRE:

import torch

from ultralytics import YOLO

# Das Modell laden
model = YOLO("yolo26n.pt")

# Ein Bild mit 0 Kanälen laden
image = torch.rand(1, 0, 640, 640)

# Das Modell ausführen
results = model(image)

Fehlermeldung:

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

Abhängigkeiten:

• torch==2.8.0
• ultralytics==8.4.142

In diesem Beispiel veranschaulicht das MRE das Problem mit möglichst wenig Code, verwendet ein öffentliches Modell ("yolo26n.pt"), enthält alle erforderlichen Abhängigkeiten und beschreibt das Problem klar samt Fehlermeldung.

Wenn du diese Richtlinien befolgst, hilfst du den Maintainerinnen und Maintainer sowie den Beitragenden der Ultralytics-YOLO-Repositories, dein Problem besser zu verstehen und effizienter zu beheben.

Häufig gestellte Fragen#