إنشاء مثال أدنى قابل لإعادة الإنتاج لتقارير الأخطاء
عند إرسال تقرير خطأ إلى مستودعات Ultralytics YOLO، من الضروري تقديم مثال أدنى قابل لإعادة الإنتاج (MRE). مثال أدنى قابل لإعادة الإنتاج هو جزء صغير ومكتفٍ بذاته من الشيفرة يوضح المشكلة التي تواجهها. ويساعد تقديم مثال أدنى قابل لإعادة الإنتاج القائمين على الصيانة والمساهمين على فهم المشكلة والعمل على إصلاحها بكفاءة أكبر. يشرح هذا الدليل كيفية إنشاء مثال أدنى قابل لإعادة الإنتاج عند إرسال تقارير أخطاء إلى مستودعات Ultralytics YOLO.
1. اعزل المشكلة#
الخطوة الأولى لإنشاء مثال أدنى قابل لإعادة الإنتاج هي عزل المشكلة. أزل أي شيفرة أو تبعيات غير ضرورية لا ترتبط مباشرة بالمشكلة. ركّز على الجزء المحدد من الشيفرة الذي يسبب المشكلة واحذف أي أقسام غير ذات صلة.
2. استخدم نماذج ومجموعات بيانات عامة#
عند إعداد MRE، استخدم نماذج ومجموعات بيانات متاحة للعامة لإعادة إنتاج المشكلة. على سبيل المثال، استخدم نموذج YOLO26n (yolo26n.pt) ومجموعة بيانات COCO8 (coco8.yaml). يضمن ذلك سهولة تشغيل المشرفين والمساهمين لمثالك والتحقيق في المشكلة من دون الحاجة إلى الوصول إلى بيانات احتكارية أو نماذج مخصصة.
3. أدرج جميع التبعيات اللازمة#
تأكد من تضمين جميع التبعيات اللازمة في المثال الأدنى القابل لإعادة الإنتاج. إذا كانت شيفرتك تعتمد على مكتبات خارجية، فحدد الحزم المطلوبة وإصداراتها. ومن الأفضل إدراج التبعيات في تقرير الخطأ باستخدام yolo checks إذا كان ultralytics مثبتًا لديك، أو باستخدام pip list للأدوات الأخرى.
4. اكتب وصفًا واضحًا للمشكلة#
قدّم وصفًا واضحًا وموجزًا للمشكلة التي تواجهها. اشرح السلوك المتوقع والسلوك الفعلي الذي تواجهه. وأدرج، عند الاقتضاء، أي رسائل خطأ أو سجلات ذات صلة.
5. نسّق شيفرتك بشكل صحيح#
نسّق شيفرتك بشكل صحيح باستخدام كتل الشيفرة في وصف المشكلة. فهذا يسهّل على الآخرين قراءة شيفرتك وفهمها. في GitHub، يمكنك إنشاء كتلة شيفرة بإحاطة شيفرتك بثلاث علامات اقتباس خلفية (```) وتحديد اللغة:
```python
# Your Python code goes here
```6. اختبر المثال الأدنى القابل لإعادة الإنتاج#
قبل إرسال المثال الأدنى القابل لإعادة الإنتاج، اختبره للتأكد من أنه يعيد إنتاج المشكلة بدقة. تأكد من أن الآخرين يستطيعون تشغيل مثالك دون أي مشكلات أو تعديلات.
مثال على مثال أدنى قابل لإعادة الإنتاج#
فيما يلي مثال على مثال أدنى قابل لإعادة الإنتاج لتقرير خطأ افتراضي:
وصف الخطأ:
عند إجراء الاستدلال على صورة ذات 0 قناة، يظهر لي خطأ متعلق بأبعاد موتر الإدخال.
مثال أدنى قابل لإعادة الإنتاج:
import torch
from ultralytics import YOLO
# حمّل النموذج
model = YOLO("yolo26n.pt")
# تحميل صورة ذات 0 قناة
image = torch.rand(1, 0, 640, 640)
# تشغيل النموذج
results = model(image)رسالة الخطأ:
RuntimeError: Expected input[1, 0, 640, 640] to have 3 channels, but got 0 channels insteadالتبعيات:
torch==2.8.0ultralytics==8.4.142
في هذا المثال، يوضح المثال الأدنى القابل لإعادة الإنتاج المشكلة باستخدام أقل قدر من الشيفرة، ويستخدم نموذجًا عامًا ("yolo26n.pt")، ويتضمن جميع التبعيات اللازمة، ويقدم وصفًا واضحًا للمشكلة إلى جانب رسالة الخطأ.
باتباع هذه الإرشادات، ستساعد المشرفين والمساهمين في مستودعات Ultralytics YOLO على فهم مشكلتك وحلها بكفاءة أكبر.
الأسئلة الشائعة#
لإنشاء مثال أدنى قابل لإعادة الإنتاج (MRE) فعال لتقارير الأخطاء في مستودعات Ultralytics YOLO، اتبع الخطوات التالية:
- اعزل المشكلة: أزل أي شيفرة أو تبعيات لا ترتبط مباشرة بالمشكلة.
- استخدم النماذج ومجموعات البيانات العامة: استخدم موارد عامة مثل
yolo26n.ptوcoco8.yamlلتسهيل إعادة إنتاج النتائج. - أدرج جميع التبعيات اللازمة: حدد الحزم المطلوبة وإصداراتها. يمكنك إدراج التبعيات باستخدام
yolo checksإذا كانultralyticsمثبتًا لديك، أو باستخدامpip list. - اكتب وصفًا واضحًا للمشكلة: اشرح السلوك المتوقع والفعلي، بما في ذلك أي رسائل خطأ أو سجلات.
- نسّق شيفرتك بشكل صحيح: استخدم كتل الشيفرة لتنسيق شيفرتك، مما يسهل قراءتها.
- اختبر المثال الأدنى القابل لإعادة الإنتاج: تأكد من أن المثال الأدنى القابل لإعادة الإنتاج يعيد إنتاج المشكلة دون تعديلات.
للاطلاع على دليل مفصل، راجع إنشاء مثال أدنى قابل لإعادة الإنتاج.
يضمن استخدام نماذج ومجموعات بيانات متاحة للعامة في المثال الأدنى القابل لإعادة الإنتاج أن يتمكن القائمون على الصيانة من تشغيل مثالك بسهولة دون الحاجة إلى الوصول إلى بيانات خاصة. وهذا يتيح حل المشكلات بسرعة وكفاءة أكبر. فعلى سبيل المثال، يساعد استخدام النموذج
yolo26n.ptومجموعة البياناتcoco8.yamlعلى توحيد عملية تصحيح الأخطاء وتبسيطها. تعرّف على المزيد حول النماذج ومجموعات البيانات العامة في قسم استخدام نماذج ومجموعات بيانات عامة.ينبغي أن يتضمن تقرير الخطأ الشامل حول Ultralytics YOLO ما يلي:
- وصف واضح: اشرح المشكلة والسلوك المتوقع والسلوك الفعلي.
- رسائل الخطأ: أدرج أي رسائل خطأ أو سجلات ذات صلة.
- التبعيات: أدرج التبعيات المطلوبة وإصداراتها.
- مثال أدنى قابل لإعادة الإنتاج (MRE): قدّم مثالًا أدنى قابلًا لإعادة الإنتاج.
- خطوات إعادة الإنتاج: وضّح الخطوات اللازمة لإعادة إنتاج المشكلة.
للحصول على قائمة تحقق كاملة، راجع قسم اكتب وصفًا واضحًا للمشكلة.
لتنسيق شيفرتك بشكل صحيح عند إرسال تقرير خطأ على GitHub:
- استخدم ثلاث علامات اقتباس خلفية (```) لإنشاء كتل الشيفرة.
- حدد لغة البرمجة لتمييز البنية، مثلًا: ```python.
- تأكد من ضبط المسافات البادئة في شيفرتك على نحو صحيح لتسهيل قراءتها.
مثال:
```python # Your Python code goes here ```للاطلاع على مزيد من النصائح حول تنسيق الشيفرة، راجع نسّق شيفرتك بشكل صحيح.
قبل إرسال المثال الأدنى القابل لإعادة الإنتاج، تأكد من:
- التحقق من إمكانية إعادة إنتاج المشكلة.
- التأكد من إدراج جميع التبعيات وصحتها.
- إزالة أي شيفرة غير ضرورية.
- اختبار المثال الأدنى القابل لإعادة الإنتاج للتأكد من أنه يعيد إنتاج المشكلة دون تعديلات.
للاطلاع على قائمة تحقق مفصلة، انتقل إلى قسم اختبر المثال الأدنى القابل لإعادة الإنتاج.
التعليقات5
اطرح سؤالًا، وشارك نتائجك، أو ساعد شخصًا آخر.
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.