مرجع ل ultralytics/utils/__init__.py
ملاحظه
هذا الملف متاح في https://github.com/ultralytics/ultralytics/ نقطة / الرئيسية /ultralytics/utils/init.py. إذا اكتشفت مشكلة ، فيرجى المساعدة في إصلاحها من خلال المساهمة في طلب 🛠️ سحب. شكرا لك 🙏!
ultralytics.utils.TQDM
قواعد: tqdm
تقليد Ultralytics فئة TQDM مع وسيطات افتراضية مختلفة.
البارامترات:
اسم | نوع | وصف | افتراضي |
---|---|---|---|
*args |
list
|
تم تمرير الحجج الموضعية إلى tqdm الأصلي. |
()
|
**kwargs |
any
|
وسيطات الكلمات الرئيسية، مع تطبيق الإعدادات الافتراضية المخصصة. |
{}
|
شفرة المصدر في ultralytics/utils/__init__.py
__init__(*args, **kwargs)
تهيئة مخصص Ultralytics فئة TQDM مع وسيطات افتراضية مختلفة.
لاحظ أنه لا يزال من الممكن تجاوزها عند استدعاء TQDM.
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.SimpleClass
Ultralytics SimpleClass هي فئة أساسية توفر تمثيلا مفيدا للسلسلة والإبلاغ عن الأخطاء والسمة طرق الوصول لتسهيل تصحيح الأخطاء والاستخدام.
شفرة المصدر في ultralytics/utils/__init__.py
__getattr__(attr)
رسالة خطأ الوصول إلى السمة المخصصة مع معلومات مفيدة.
شفرة المصدر في ultralytics/utils/__init__.py
__repr__()
__str__()
إرجاع تمثيل سلسلة يمكن للإنسان قراءته للكائن.
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.IterableSimpleNamespace
قواعد: SimpleNamespace
Ultralytics IterableSimpleNamespace هي فئة ملحق من SimpleNamespace تضيف وظائف قابلة للتكرار و تمكين الاستخدام مع dict () وللحلقات.
شفرة المصدر في ultralytics/utils/__init__.py
__getattr__(attr)
رسالة خطأ الوصول إلى السمة المخصصة مع معلومات مفيدة.
شفرة المصدر في ultralytics/utils/__init__.py
__iter__()
__str__()
get(key, default=None)
ultralytics.utils.ThreadingLocked
فئة ديكور لضمان التنفيذ الآمن للخيط لوظيفة أو طريقة. يمكن استخدام هذه الفئة كديكور للتأكد من أنه إذا تم استدعاء الوظيفة المزخرفة من مؤشرات ترابط متعددة ، فلن يتمكن سوى مؤشر ترابط واحد في كل مرة لتنفيذ الوظيفة.
سمات:
اسم | نوع | وصف |
---|---|---|
lock |
Lock
|
كائن قفل يستخدم لإدارة الوصول إلى الوظيفة المزخرفة. |
مثل
شفرة المصدر في ultralytics/utils/__init__.py
__call__(f)
قم بتشغيل التنفيذ الآمن لمؤشر الترابط للوظيفة أو الطريقة.
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.TryExcept
قواعد: ContextDecorator
Ultralytics حاول باستثناء الطبقة. استخدم كمصمم ديكور @TryExcept () أو "مع TryCept():" مدير السياق.
امثله:
كمصمم ديكور:
>>> @TryExcept(msg="Error occurred in func", verbose=True)
>>> def func():
>>> # Function logic here
>>> pass
بصفتك مديرا للسياق:
شفرة المصدر في ultralytics/utils/__init__.py
__enter__()
__exit__(exc_type, value, traceback)
يحدد السلوك عند الخروج من كتلة "مع" ، ويطبع رسالة خطأ إذا لزم الأمر.
__init__(msg='', verbose=True)
ultralytics.utils.Retry
قواعد: ContextDecorator
أعد محاولة الفئة لتنفيذ الدالة مع التراجع الأسي.
يمكن استخدامه كمصمم ديكور أو مدير سياق لإعادة محاولة وظيفة أو كتلة من التعليمات البرمجية على الاستثناءات ، حتى عدد محدد من المرات مع تأخير متزايد بشكل كبير بين مرات المحاولة.
امثله:
مثال على الاستخدام كديكور:
>>> @Retry(times=3, delay=2)
>>> def test_func():
>>> # Replace with function logic that may raise exceptions
>>> return True
مثال على الاستخدام كمدير سياق:
شفرة المصدر في ultralytics/utils/__init__.py
__call__(func)
تنفيذ الديكور لإعادة المحاولة مع تراجع أسي.
شفرة المصدر في ultralytics/utils/__init__.py
__enter__()
__exit__(exc_type, exc_value, traceback)
قم بإنهاء سياق وقت التشغيل المتعلق بهذا الكائن مع التراجع الأسي.
شفرة المصدر في ultralytics/utils/__init__.py
__init__(times=3, delay=2)
تهيئة فئة إعادة المحاولة مع عدد محدد من عمليات إعادة المحاولة والتأخير.
ultralytics.utils.SettingsManager
قواعد: dict
يدير Ultralytics الإعدادات المخزنة في ملف YAML.
البارامترات:
اسم | نوع | وصف | افتراضي |
---|---|---|---|
file |
str | Path
|
الطريق إلى Ultralytics إعدادات ملف YAML. الافتراضي هو USER_CONFIG_DIR / 'settings.yaml'. |
SETTINGS_YAML
|
version |
str
|
إصدار الإعدادات. في حالة عدم تطابق الإصدار المحلي ، سيتم حفظ الإعدادات الافتراضية الجديدة. |
'0.0.4'
|
شفرة المصدر في ultralytics/utils/__init__.py
955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 |
|
__init__(file=SETTINGS_YAML, version='0.0.4')
تهيئة مدير الإعدادات بالإعدادات الافتراضية ، وتحميل الإعدادات الحالية والتحقق من صحتها من YAML ملف.
شفرة المصدر في ultralytics/utils/__init__.py
load()
reset()
save()
ultralytics.utils.plt_settings(rcparams=None, backend='Agg')
مصمم لتعيين معلمات rc مؤقتا والواجهة الخلفية لوظيفة التخطيط.
مثل
decorator: @plt_settings({"font.size": 12}) context manager: with plt_settings({"font.size": 12}):
البارامترات:
اسم | نوع | وصف | افتراضي |
---|---|---|---|
rcparams |
dict
|
قاموس معلمات RC لتعيين. |
None
|
backend |
str
|
اسم الواجهة الخلفية المراد استخدامها. الإعدادات الافتراضية إلى "Agg". |
'Agg'
|
ارجاع:
نوع | وصف |
---|---|
Callable
|
وظيفة مزينة مع تعيين مؤقتا معلمات rc والخلفية. يمكن أن يكون هذا الديكور يتم تطبيقه على أي وظيفة تحتاج إلى معلمات Matplotlib RC محددة وخلفية لتنفيذها. |
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.set_logging(name='LOGGING_NAME', verbose=True)
يقوم بإعداد التسجيل للاسم المحدد مع دعم ترميز UTF-8 ، مما يضمن التوافق عبر مختلف البيئات.
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.emojis(string='')
ultralytics.utils.yaml_save(file='data.yaml', data=None, header='')
حفظ بيانات YAML في ملف.
البارامترات:
اسم | نوع | وصف | افتراضي |
---|---|---|---|
file |
str
|
اسم الملف. الافتراضي هو "data.yaml". |
'data.yaml'
|
data |
dict
|
البيانات المراد حفظها بتنسيق YAML. |
None
|
header |
str
|
رأس YAML لإضافته. |
''
|
ارجاع:
نوع | وصف |
---|---|
None
|
يتم حفظ البيانات في الملف المحدد. |
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.yaml_load(file='data.yaml', append_filename=False)
تحميل بيانات YAML من ملف.
البارامترات:
اسم | نوع | وصف | افتراضي |
---|---|---|---|
file |
str
|
اسم الملف. الافتراضي هو "data.yaml". |
'data.yaml'
|
append_filename |
bool
|
إضافة اسم ملف YAML إلى قاموس YAML. الافتراضي هو خطأ. |
False
|
ارجاع:
نوع | وصف |
---|---|
dict
|
بيانات YAML واسم الملف. |
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.yaml_print(yaml_file)
جميلة تطبع ملف YAML أو قاموس YAML.
البارامترات:
اسم | نوع | وصف | افتراضي |
---|---|---|---|
yaml_file |
Union[str, Path, dict]
|
مسار ملف ملف YAML أو قاموس بتنسيق YAML. |
مطلوب |
ارجاع:
نوع | وصف |
---|---|
None
|
(لا يوجد) |
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.read_device_model()
يقرأ معلومات نموذج الجهاز من النظام ويخزنها مؤقتًا للوصول السريع. يُستخدم بواسطة is_jetson() و is_raspberrypi().
ارجاع:
نوع | وصف |
---|---|
str
|
محتويات الملف النموذجي إذا تمت قراءته بنجاح أو سلسلة فارغة في غير ذلك. |
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.is_ubuntu()
تحقق مما إذا كان نظام التشغيل هو أوبونتو.
ارجاع:
نوع | وصف |
---|---|
bool
|
صحيح إذا كان نظام التشغيل هو Ubuntu ، خطأ خلاف ذلك. |
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.is_colab()
تحقق مما إذا كان النص البرمجي الحالي يعمل داخل دفتر ملاحظات Google Colab.
ارجاع:
نوع | وصف |
---|---|
bool
|
صحيح إذا كان يعمل داخل دفتر ملاحظات كولاب ، خطأ خلاف ذلك. |
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.is_kaggle()
تحقق مما إذا كان البرنامج النصي الحالي يعمل داخل نواة Kaggle.
ارجاع:
نوع | وصف |
---|---|
bool
|
صحيح إذا كان يعمل داخل نواة Kaggle ، خطأ خلاف ذلك. |
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.is_jupyter()
تحقق مما إذا كان البرنامج النصي الحالي يعمل داخل دفتر ملاحظات Jupyter. تم التحقق منه على كولاب ، جوبيترلاب ، كاجل ، Paperspace.
ارجاع:
نوع | وصف |
---|---|
bool
|
صحيح إذا كان يعمل داخل دفتر Jupyter ، خطأ خلاف ذلك. |
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.is_docker()
حدد ما إذا كان البرنامج النصي يعمل داخل حاوية Docker.
ارجاع:
نوع | وصف |
---|---|
bool
|
صحيح إذا كان البرنامج النصي يعمل داخل حاوية Docker ، خطأ خلاف ذلك. |
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.is_raspberrypi()
يحدّد ما إذا كانت البيئة Python تعمل على جهاز Raspberry Pi من خلال التحقق من معلومات طراز الجهاز.
ارجاع:
نوع | وصف |
---|---|
bool
|
صواب إذا كان يعمل على جهاز Raspberry Pi، وكاذب إذا كان يعمل على جهاز Raspberry Pi، وكاذب إذا كان يعمل على جهاز Raspberry Pi، وكاذب إذا كان غير ذلك. |
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.is_jetson()
يُحدد ما إذا كانت البيئة Python تعمل على جهاز Jetson Nano أو Jetson Orin من خلال التحقق من طراز الجهاز المعلومات.
ارجاع:
نوع | وصف |
---|---|
bool
|
صواب في حالة التشغيل على Jetson Nano أو Jetson Orin، خطأ في غير ذلك. |
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.is_online()
تحقق من الاتصال بالإنترنت عن طريق محاولة الاتصال بمضيف معروف عبر الإنترنت.
ارجاع:
نوع | وصف |
---|---|
bool
|
صحيح إذا كان الاتصال ناجحا ، خطأ خلاف ذلك. |
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.is_pip_package(filepath=__name__)
يحدد ما إذا كان الملف في مسار الملف المحدد هو جزء من حزمة نقطة.
البارامترات:
اسم | نوع | وصف | افتراضي |
---|---|---|---|
filepath |
str
|
مسار الملف للتحقق. |
__name__
|
ارجاع:
نوع | وصف |
---|---|
bool
|
صحيح إذا كان الملف جزءا من حزمة نقطة ، خطأ خلاف ذلك. |
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.is_dir_writeable(dir_path)
تحقق مما إذا كان الدليل قابلا للكتابة.
البارامترات:
اسم | نوع | وصف | افتراضي |
---|---|---|---|
dir_path |
str | Path
|
المسار إلى الدليل. |
مطلوب |
ارجاع:
نوع | وصف |
---|---|
bool
|
صحيح إذا كان الدليل قابلا للكتابة ، خطأ بخلاف ذلك. |
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.is_pytest_running()
يحدد ما إذا كان pytest قيد التشغيل حاليا أم لا.
ارجاع:
نوع | وصف |
---|---|
bool
|
صحيح إذا كان pytest قيد التشغيل ، خطأ خلاف ذلك. |
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.is_github_action_running()
حدد ما إذا كانت البيئة الحالية عداء إجراءات GitHub.
ارجاع:
نوع | وصف |
---|---|
bool
|
صحيح إذا كانت البيئة الحالية عبارة عن عداء GitHub Actions ، فهذا خطأ بخلاف ذلك. |
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.get_git_dir()
يحدد ما إذا كان الملف الحالي جزءا من مستودع git وإذا كان الأمر كذلك، فيرجع الدليل الجذر للمستودع. لو الملف الحالي ليس جزءا من مستودع git ، يقوم بإرجاع بلا.
ارجاع:
نوع | وصف |
---|---|
Path | None
|
دليل جذر Git إذا تم العثور عليه أو لا شيء إذا لم يتم العثور عليه. |
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.is_git_dir()
يحدد ما إذا كان الملف الحالي جزءا من مستودع git أم لا. إذا لم يكن الملف الحالي جزءا من git المستودع، إرجاع بلا.
ارجاع:
نوع | وصف |
---|---|
bool
|
صحيح إذا كان الملف الحالي جزءا من مستودع git. |
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.get_git_origin_url()
يسترجع عنوان URL الأصلي لمستودع git.
ارجاع:
نوع | وصف |
---|---|
str | None
|
عنوان URL الأصلي لمستودع git أو لا شيء إن لم يكن دليل git. |
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.get_git_branch()
إرجاع اسم فرع git الحالي. إذا لم يكن في مستودع git ، فترجع بلا.
ارجاع:
نوع | وصف |
---|---|
str | None
|
اسم فرع git الحالي أو لا شيء إن لم يكن دليل git. |
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.get_default_args(func)
إرجاع قاموس للوسيطات الافتراضية لدالة.
البارامترات:
اسم | نوع | وصف | افتراضي |
---|---|---|---|
func |
callable
|
وظيفة التفتيش. |
مطلوب |
ارجاع:
نوع | وصف |
---|---|
dict
|
قاموس حيث يكون كل مفتاح هو اسم معلمة ، وكل قيمة هي القيمة الافتراضية لتلك المعلمة. |
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.get_ubuntu_version()
استرجع إصدار Ubuntu إذا كان نظام التشغيل هو Ubuntu.
ارجاع:
نوع | وصف |
---|---|
str
|
إصدار Ubuntu أو لا شيء إن لم يكن نظام تشغيل Ubuntu. |
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.get_user_config_dir(sub_dir='Ultralytics')
إرجاع دليل التكوين المناسب استنادا إلى نظام تشغيل البيئة.
البارامترات:
اسم | نوع | وصف | افتراضي |
---|---|---|---|
sub_dir |
str
|
اسم الدليل الفرعي المراد إنشاؤه. |
'Ultralytics'
|
ارجاع:
نوع | وصف |
---|---|
Path
|
المسار إلى دليل تكوين المستخدم. |
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.colorstr(*input)
يلون سلسلة بناء على وسيطات اللون والنمط المتوفرة. يستخدم رموز الهروب ANSI. راجع https://en.wikipedia.org/wiki/ANSI_escape_code لمزيد من التفاصيل.
يمكن استدعاء هذه الوظيفة بطريقتين
- colorstr ("اللون" ، "النمط" ، "السلسلة الخاصة بك")
- Colorstr ("سلسلتك")
في النموذج الثاني ، سيتم تطبيق "الأزرق" و "الغامق" افتراضيا.
البارامترات:
اسم | نوع | وصف | افتراضي |
---|---|---|---|
*input |
str
|
سلسلة من السلاسل حيث تكون سلاسل n-1 الأولى عبارة عن وسيطات اللون والنمط ، والخيط الأخير هو الذي سيتم تلوينه. |
()
|
الألوان والأنماط المدعومة
الألوان الأساسية: "أسود" ، "أحمر" ، "أخضر" ، "أصفر" ، "أزرق" ، "أرجواني" ، "سماوي" ، "أبيض" الألوان الزاهية: "bright_black" ، "bright_red" ، "bright_green" ، "bright_yellow" ، "bright_blue" و "bright_magenta" و "bright_cyan" و "bright_white" متفرقات: "نهاية" ، "جريئة" ، "تسطير"
ارجاع:
نوع | وصف |
---|---|
str
|
سلسلة الإدخال ملفوفة برموز الهروب ANSI للون والنمط المحددين. |
امثله:
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.remove_colorstr(input_string)
يزيل رموز الهروب ANSI من سلسلة ، وإلغاء تلوينها بشكل فعال.
البارامترات:
اسم | نوع | وصف | افتراضي |
---|---|---|---|
input_string |
str
|
سلسلة لإزالة اللون والنمط من. |
مطلوب |
ارجاع:
نوع | وصف |
---|---|
str
|
تمت إزالة سلسلة جديدة مع إزالة جميع رموز الهروب ANSI. |
امثله:
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.threaded(func)
مؤشرات الترابط المتعددة دالة هدف بشكل افتراضي وإرجاع نتيجة مؤشر الترابط أو الدالة.
استخدم كديكور @threaded. تعمل الدالة في مؤشر ترابط منفصل ما لم يتم تمرير "threaded = False".
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.set_sentry()
تهيئة Sentry SDK لتعقب الأخطاء وإعداد التقارير. تستخدم فقط إذا تم تثبيت sentry_sdk الحزمة و sync = صحيح في الإعدادات. تشغيل 'yolo 'لرؤية وتحديث إعدادات ملف YAML.
الشروط المطلوبة لإرسال الأخطاء (يجب استيفاء جميع الشروط أو لن يتم الإبلاغ عن أي أخطاء): - تم تثبيت حزمة sentry_sdk - sync = صحيح في YOLO اعدادات - pytest لا يعمل - يعمل في تثبيت حزمة نقطة - يعمل في دليل غير git - الجري برتبة -1 أو 0 - بيئة على الانترنت - CLI تستخدم لتشغيل الحزمة (تم التحقق منها باستخدام 'yolo' كاسم رئيسي CLI أمر)
تقوم الدالة أيضا بتكوين Sentry SDK لتجاهل KeyboardInterrupt و FileNotFoundError الاستثناءات واستبعاد الأحداث التي تحتوي على "نفاد الذاكرة" في رسالة الاستثناء الخاصة بها.
بالإضافة إلى ذلك ، تقوم الوظيفة بتعيين علامات مخصصة ومعلومات المستخدم لأحداث Sentry.
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.deprecation_warn(arg, new_arg, version=None)
إصدار تحذير إيقاف عند استخدام وسيطة مهملة، مما يشير إلى وسيطة محدثة.
شفرة المصدر في ultralytics/utils/__init__.py
ultralytics.utils.clean_url(url)
قم بتجريد المصادقة من عنوان URL ، أي https://url.com/file.txt?auth -> https://url.com/file.txt.