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 (yolo26n.pt) und den Datensatz COCO8 (coco8.yaml). So können Maintainer und Mitwirkende dein Beispiel einfach 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 insteadAbhängigkeiten:
torch==2.8.0ultralytics==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 Maintainer und Mitwirkenden der Ultralytics-YOLO-Repositories, dein Problem besser zu verstehen und effizienter zu lösen.
Häufig gestellte Fragen#
Gehe folgendermaßen vor, um ein aussagekräftiges minimales reproduzierbares Beispiel (MRE) für Fehlerberichte in Ultralytics-YOLO-Repositories zu erstellen:
- Problem eingrenzen: Entferne Code und Abhängigkeiten, die nicht unmittelbar mit dem Problem zusammenhängen.
- Öffentliche Modelle und Datensätze verwenden: Nutze öffentliche Ressourcen wie
yolo26n.ptundcoco8.yaml, damit sich das Problem leichter reproduzieren lässt. - Alle erforderlichen Abhängigkeiten angeben: Gib die benötigten Pakete und deren Versionen an. Du kannst die Abhängigkeiten mit
yolo checksaufführen, wennultralyticsinstalliert ist, oder mitpip list. - Das Problem klar beschreiben: Erläutere das erwartete und das tatsächliche Verhalten, einschließlich etwaiger Fehlermeldungen oder Protokolle.
- Code richtig formatieren: Verwende Codeblöcke, damit dein Code leichter lesbar ist.
- MRE testen: Stelle sicher, dass dein MRE das Problem ohne Änderungen reproduziert.
Eine ausführliche Anleitung findest du unter Ein minimales reproduzierbares Beispiel erstellen.
Wenn du für dein MRE öffentlich verfügbare Modelle und Datensätze verwendest, können Maintainerinnen und Maintainer dein Beispiel problemlos ausführen, ohne Zugriff auf proprietäre Daten zu benötigen. So lassen sich Probleme schneller und effizienter beheben. Beispielsweise helfen das Modell
yolo26n.ptund der Datensatzcoco8.yamldabei, die Fehlersuche zu vereinheitlichen und zu vereinfachen. Weitere Informationen zu öffentlichen Modellen und Datensätzen findest du im Abschnitt Öffentliche Modelle und Datensätze verwenden.Ein umfassender Fehlerbericht für Ultralytics YOLO sollte Folgendes enthalten:
- Klare Beschreibung: Erläutere das Problem, das erwartete Verhalten und das tatsächliche Verhalten.
- Fehlermeldungen: Füge relevante Fehlermeldungen oder Protokolle hinzu.
- Abhängigkeiten: Führe die benötigten Abhängigkeiten und deren Versionen auf.
- MRE: Stelle ein minimales reproduzierbares Beispiel bereit.
- Schritte zur Reproduktion: Beschreibe die Schritte, mit denen sich das Problem reproduzieren lässt.
Eine vollständige Checkliste findest du im Abschnitt Das Problem klar beschreiben.
So formatierst du deinen Code richtig, wenn du einen Fehlerbericht auf GitHub einreichst:
- Verwende dreifache Backticks (```), um Codeblöcke zu erstellen.
- Gib die Programmiersprache für die Syntaxhervorhebung an, z. B. ```python.
- Achte auf die richtige Einrückung deines Codes, damit er gut lesbar ist.
Beispiel:
```python # Your Python code goes here ```Weitere Tipps zur Codeformatierung findest du unter Code richtig formatieren.
Bevor du dein MRE einreichst, solltest du Folgendes sicherstellen:
- Überprüfe, ob sich das Problem reproduzieren lässt.
- Stelle sicher, dass alle Abhängigkeiten aufgeführt und korrekt sind.
- Entferne unnötigen Code.
- Teste das MRE, um sicherzustellen, dass es das Problem ohne Änderungen reproduziert.
Eine ausführliche Checkliste findest du im Abschnitt MRE testen.
Kommentare5
Stell eine Frage, teile deine Ergebnisse oder hilf jemand anderem.
AVON257
Thanks for this, I'll get back to you as soon as I can, although it was the lvis dataset that produced these errors.
Does that make any difference?
On Wed, 26 Feb 2025, 17:00 Glenn Jocher, @.***> wrote:
@AVON257 https://github.com/AVON257 hi Tom, thanks for reporting this. To help us investigate, please create a Minimum Reproducible Example using the COCO8-OBB dataset and share your exact training/validation commands, dependency versions (yolo checks), and complete error logs. The validation logic is handled in the Val mode - you can review the source code in the Ultralytics repository.
For potential contributions, we welcome PRs that follow our Contributing Guide including signed CLA and Google-style docstrings. The community will appreciate your improvements to YOLO compatibility across hardware platforms.
— Reply to this email directly, view it on GitHub https://github.com/orgs/ultralytics/discussions/19445#discussioncomment-12328645, or unsubscribe https://github.com/notifications/unsubscribe-auth/AMWQGN6XUAOONBP7JBOKO7L2RXXLTAVCNFSM6AAAAABX5TFNQWVHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTEMZSHA3DINI . You are receiving this because you were mentioned.Message ID: @.*** com>
Glenn JocherUltralytics@AVON257 hi there! While the LVIS dataset context is helpful, we still need a Minimum Reproducible Example with the COCO8-OBB dataset (or another public dataset) to efficiently investigate this issue. Please share your exact training/validation commands,
yolo checksoutput, and full error traceback when using a public dataset. This standardized approach helps us resolve issues faster for everyone. For MRE guidelines, see Creating a Minimum Reproducible Example. 😊
AVON257
Hi, I'd just like to mention that I have found a bug on the validation model (if it is a bug), where when I train a nano sized OBB model on YOLO 12 unfortunately it either produces Nan's during training or it won't validate on my RTX3090, even though it isn't showing that it's using too much memory when I try it with any batch size.
Any ideas on this?
Thanks,
Tom T.
P.S. I am actively working on combining this with quantum circuits but in order to do that, I need to be able to test it against the classical baseline, and curiously it seems okay on Colab when I tried it on an A100 but not on my RTX3090.
P.P.S. I would very much like to submit a commit to you once I finish my current work on the latest version of Ultralytics if you don't mind, although I should tell you that it will only work with optimal performance on Nvidia hardware at the moment. It can work on other things too, it just won't work as fast that way.
AVON257
In fact I would debug it myself if I could figure out which part of ultralytics deals with validation, any ideas?
Glenn JocherUltralytics@AVON257 hi Tom, thanks for reporting this. To help us investigate, please create a Minimum Reproducible Example using the COCO8-OBB dataset and share your exact training/validation commands, dependency versions (
yolo checks), and complete error logs. The validation logic is handled in the Val mode - you can review the source code in the Ultralytics repository.For potential contributions, we welcome PRs that follow our Contributing Guide including signed CLA and Google-style docstrings. The community will appreciate your improvements to YOLO compatibility across hardware platforms.