Referans için ultralytics/utils/__init__.py
Not
Bu dosya https://github.com/ultralytics/ultralytics/blob/main/ ultralytics/utils/init.py adresinde mevcuttur. Bir sorun tespit ederseniz lütfen bir Çekme İsteği 🛠️ ile katkıda bulunarak düzeltilmesine yardımcı olun. Teşekkürler 🙏!
ultralytics.utils.TQDM
Üsler: tqdm
Farklı varsayılan argümanlara sahip özel Ultralytics tqdm sınıfı.
Parametreler:
İsim | Tip | Açıklama | Varsayılan |
---|---|---|---|
*args |
list
|
Orijinal tqdm'ye aktarılan konumsal argümanlar. |
()
|
**kwargs |
any
|
Özel varsayılanlar uygulanmış anahtar kelime argümanları. |
{}
|
Kaynak kodu ultralytics/utils/__init__.py
__init__(*args, **kwargs)
Özel Ultralytics tqdm sınıfını farklı varsayılan argümanlarla başlatın.
TQDM çağrılırken bunların hala geçersiz kılınabileceğini unutmayın.
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.SimpleClass
Ultralytics SimpleClass yararlı dize gösterimi, hata raporlama ve öznitelik sağlayan bir temel sınıftır daha kolay hata ayıklama ve kullanım için erişim yöntemleri.
Kaynak kodu ultralytics/utils/__init__.py
__getattr__(attr)
Yardımcı bilgiler içeren özel öznitelik erişim hata mesajı.
__repr__()
__str__()
Nesnenin insan tarafından okunabilir bir dize gösterimini döndürür.
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.IterableSimpleNamespace
Üsler: SimpleNamespace
Ultralytics IterableSimpleNamespace, SimpleNamespace'in yinelenebilir işlevsellik ekleyen bir uzantı sınıfıdır ve dict() ve for döngüleri ile kullanım sağlar.
Kaynak kodu ultralytics/utils/__init__.py
__getattr__(attr)
Yardımcı bilgiler içeren özel öznitelik erişim hata mesajı.
Kaynak kodu ultralytics/utils/__init__.py
__iter__()
__str__()
get(key, default=None)
Varsa, belirtilen anahtarın değerini döndürür; aksi takdirde, varsayılan değeri döndürür.
ultralytics.utils.ThreadingLocked
Bir işlev veya yöntemin iş parçacığı güvenli yürütülmesini sağlayan bir dekoratör sınıfı. Bu sınıf bir dekoratör olarak kullanılabilir dekore edilmiş fonksiyonun birden fazla iş parçacığından çağrılması durumunda, her seferinde yalnızca bir iş parçacığının fonksiyonu çalıştırmak için.
Nitelikler:
İsim | Tip | Açıklama |
---|---|---|
lock |
Lock
|
Dekore edilmiş fonksiyona erişimi yönetmek için kullanılan bir kilit nesnesi. |
Örnek
Kaynak kodu ultralytics/utils/__init__.py
__call__(f)
İşlev veya yöntemin iş parçacığı güvenli yürütülmesini çalıştırın.
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.TryExcept
Üsler: ContextDecorator
Ultralytics TryExcept sınıfı. TryExcept() dekoratörü veya 'with TryExcept():' bağlam yöneticisi olarak kullanın.
Örnekler:
Bir dekoratör olarak:
>>> @TryExcept(msg="Error occurred in func", verbose=True)
>>> def func():
>>> # Function logic here
>>> pass
Bir bağlam yöneticisi olarak:
Kaynak kodu ultralytics/utils/__init__.py
__enter__()
__exit__(exc_type, value, traceback)
Bir 'with' bloğundan çıkarken davranışı tanımlar, gerekirse hata mesajı yazdırır.
__init__(msg='', verbose=True)
ultralytics.utils.Retry
Üsler: ContextDecorator
Üstel geri alma ile işlev yürütme için yeniden deneme sınıfı.
İstisnalarda bir işlevi veya kod bloğunu yeniden denemek için bir dekoratör veya bağlam yöneticisi olarak kullanılabilir, en fazla Yeniden denemeler arasında üstel olarak artan bir gecikme ile belirtilen sayıda kez.
Örnekler:
Dekoratör olarak örnek kullanım:
>>> @Retry(times=3, delay=2)
>>> def test_func():
>>> # Replace with function logic that may raise exceptions
>>> return True
Bağlam yöneticisi olarak örnek kullanım:
Kaynak kodu ultralytics/utils/__init__.py
__call__(func)
Üstel geri alma ile yeniden deneme için dekoratör uygulaması.
Kaynak kodu ultralytics/utils/__init__.py
__enter__()
__exit__(exc_type, exc_value, traceback)
Bu nesneyle ilgili çalışma zamanı bağlamından üstel geri alma ile çıkın.
Kaynak kodu ultralytics/utils/__init__.py
__init__(times=3, delay=2)
Retry sınıfını belirtilen sayıda tekrar deneme ve gecikme ile başlatın.
ultralytics.utils.SettingsManager
Üsler: dict
Bir YAML dosyasında saklanan Ultralytics ayarlarını yönetir.
Parametreler:
İsim | Tip | Açıklama | Varsayılan |
---|---|---|---|
file |
str | Path
|
Ultralytics settings YAML dosyasının yolu. Varsayılan USER_CONFIG_DIR / 'settings.yaml' şeklindedir. |
SETTINGS_YAML
|
version |
str
|
Ayar sürümü. Yerel sürüm uyuşmazlığı durumunda, yeni varsayılan ayarlar kaydedilecektir. |
'0.0.4'
|
Kaynak kodu 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')
SettingsManager'ı varsayılan ayarlarla başlatın, mevcut ayarları YAML'den yükleyin ve doğrulayın Dosya.
Kaynak kodu ultralytics/utils/__init__.py
load()
reset()
save()
ultralytics.utils.plt_settings(rcparams=None, backend='Agg')
Bir çizim işlevi için rc parametrelerini ve arka ucu geçici olarak ayarlamak için dekoratör.
Örnek
decorator: @plt_settings({"font.size": 12}) context manager: with plt_settings({"font.size": 12}):
Parametreler:
İsim | Tip | Açıklama | Varsayılan |
---|---|---|---|
rcparams |
dict
|
Ayarlanacak rc parametreleri sözlüğü. |
None
|
backend |
str
|
Kullanılacak arka ucun adı. Varsayılan olarak 'Agg'. |
'Agg'
|
İade:
Tip | Açıklama |
---|---|
Callable
|
Geçici olarak ayarlanmış rc parametreleri ve arka uç ile süslenmiş işlev. Bu dekoratör şu şekilde olabilir belirli matplotlib rc parametrelerine ve yürütülmesi için arka uca sahip olması gereken herhangi bir işleve uygulanır. |
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.set_logging(name='LOGGING_NAME', verbose=True)
UTF-8 kodlama desteği ile verilen ad için günlük kaydını ayarlar ve farklı adlar arasında uyumluluk sağlar. ortamlar.
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.emojis(string='')
ultralytics.utils.yaml_save(file='data.yaml', data=None, header='')
YAML verilerini bir dosyaya kaydedin.
Parametreler:
İsim | Tip | Açıklama | Varsayılan |
---|---|---|---|
file |
str
|
Dosya adı. Varsayılan 'data.yaml' şeklindedir. |
'data.yaml'
|
data |
dict
|
YAML biçiminde kaydedilecek veriler. |
None
|
header |
str
|
Eklenecek YAML başlığı. |
''
|
İade:
Tip | Açıklama |
---|---|
None
|
Veriler belirtilen dosyaya kaydedilir. |
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.yaml_load(file='data.yaml', append_filename=False)
Bir dosyadan YAML verilerini yükleyin.
Parametreler:
İsim | Tip | Açıklama | Varsayılan |
---|---|---|---|
file |
str
|
Dosya adı. Varsayılan 'data.yaml' şeklindedir. |
'data.yaml'
|
append_filename |
bool
|
YAML dosya adını YAML sözlüğüne ekleyin. Varsayılan değer False'dir. |
False
|
İade:
Tip | Açıklama |
---|---|
dict
|
YAML verileri ve dosya adı. |
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.yaml_print(yaml_file)
Pretty, bir YAML dosyasını veya YAML biçimlendirilmiş bir sözlüğü yazdırır.
Parametreler:
İsim | Tip | Açıklama | Varsayılan |
---|---|---|---|
yaml_file |
Union[str, Path, dict]
|
YAML dosyasının veya YAML biçimlendirilmiş bir sözlüğün dosya yolu. |
gerekli |
İade:
Tip | Açıklama |
---|---|
None
|
(Yok) |
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.read_device_model()
Aygıt modeli bilgisini sistemden okur ve hızlı erişim için önbelleğe alır. is_jetson() tarafından kullanılır ve is_raspberrypi().
İade:
Tip | Açıklama |
---|---|
str
|
Başarılı bir şekilde okunursa model dosyası içeriği, aksi takdirde boş dize. |
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.is_ubuntu()
İşletim sisteminin Ubuntu olup olmadığını kontrol edin.
İade:
Tip | Açıklama |
---|---|
bool
|
İşletim sistemi Ubuntu ise True, değilse False. |
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.is_colab()
Geçerli betiğin bir Google Colab not defteri içinde çalışıp çalışmadığını kontrol edin.
İade:
Tip | Açıklama |
---|---|
bool
|
Bir Colab not defteri içinde çalışıyorsa True, aksi takdirde False. |
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.is_kaggle()
Geçerli betiğin bir Kaggle çekirdeği içinde çalışıp çalışmadığını kontrol edin.
İade:
Tip | Açıklama |
---|---|
bool
|
Bir Kaggle çekirdeği içinde çalışıyorsa True, aksi takdirde False. |
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.is_jupyter()
Geçerli betiğin bir Jupyter Notebook içinde çalışıp çalışmadığını kontrol edin. Colab, Jupyterlab, Kaggle, Paperspace üzerinde doğrulanmıştır.
İade:
Tip | Açıklama |
---|---|
bool
|
Bir Jupyter Notebook içinde çalışıyorsa True, aksi takdirde False. |
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.is_docker()
Komut dosyasının bir Docker konteynerinin içinde çalışıp çalışmadığını belirleyin.
İade:
Tip | Açıklama |
---|---|
bool
|
Kod bir Docker konteynerinin içinde çalışıyorsa True, aksi takdirde False. |
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.is_raspberrypi()
Cihaz model bilgisini kontrol ederek Python ortamının bir Raspberry Pi üzerinde çalışıp çalışmadığını belirler.
İade:
Tip | Açıklama |
---|---|
bool
|
Raspberry Pi üzerinde çalışıyorsa True, aksi takdirde False. |
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.is_jetson()
Cihaz modelini kontrol ederek Python ortamının bir Jetson Nano veya Jetson Orin cihazında çalışıp çalışmadığını belirler Bilgi.
İade:
Tip | Açıklama |
---|---|
bool
|
Jetson Nano veya Jetson Orin üzerinde çalışıyorsa True, aksi takdirde False. |
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.is_online()
Bilinen bir çevrimiçi ana bilgisayara bağlanmayı deneyerek internet bağlantısını kontrol edin.
İade:
Tip | Açıklama |
---|---|
bool
|
Bağlantı başarılıysa True, aksi takdirde False. |
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.is_pip_package(filepath=__name__)
Verilen dosya yolundaki dosyanın bir pip paketinin parçası olup olmadığını belirler.
Parametreler:
İsim | Tip | Açıklama | Varsayılan |
---|---|---|---|
filepath |
str
|
Kontrol edilecek dosya yolu. |
__name__
|
İade:
Tip | Açıklama |
---|---|
bool
|
Dosya bir pip paketinin parçasıysa True, değilse False. |
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.is_dir_writeable(dir_path)
Bir dizinin yazılabilir olup olmadığını kontrol edin.
Parametreler:
İsim | Tip | Açıklama | Varsayılan |
---|---|---|---|
dir_path |
str | Path
|
Dizine giden yol. |
gerekli |
İade:
Tip | Açıklama |
---|---|
bool
|
Dizin yazılabilir durumdaysa True, aksi takdirde False. |
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.is_pytest_running()
pytest'in o anda çalışıp çalışmadığını belirler.
İade:
Tip | Açıklama |
---|---|
bool
|
pytest çalışıyorsa True, aksi takdirde False. |
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.is_github_action_running()
Geçerli ortamın bir GitHub Actions runner olup olmadığını belirleyin.
İade:
Tip | Açıklama |
---|---|
bool
|
Geçerli ortam bir GitHub Actions runner ise True, aksi takdirde False. |
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.get_git_dir()
Geçerli dosyanın bir git deposunun parçası olup olmadığını belirler ve eğer öyleyse, depo kök dizinini döndürür. Eğer geçerli dosya bir git deposunun parçası değilse, None döndürür.
İade:
Tip | Açıklama |
---|---|
Path | None
|
Bulunursa Git kök dizini veya bulunamazsa Hiçbiri. |
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.is_git_dir()
Geçerli dosyanın bir git deposunun parçası olup olmadığını belirler. Geçerli dosya bir git deposunun parçası değilse deposu, Hiçbiri döndürür.
İade:
Tip | Açıklama |
---|---|
bool
|
Geçerli dosya bir git deposunun parçasıysa true. |
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.get_git_origin_url()
Bir git deposunun kaynak URL'sini alır.
İade:
Tip | Açıklama |
---|---|
str | None
|
git deposunun kaynak URL'si veya git dizini değilse None. |
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.get_git_branch()
Geçerli git dalı adını döndürür. Eğer bir git deposunda değilse, None döndürür.
İade:
Tip | Açıklama |
---|---|
str | None
|
Geçerli git dalı adı veya bir git dizini değilse None. |
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.get_default_args(func)
Bir işlev için varsayılan bağımsız değişkenler sözlüğü döndürür.
Parametreler:
İsim | Tip | Açıklama | Varsayılan |
---|---|---|---|
func |
callable
|
İncelenecek fonksiyon. |
gerekli |
İade:
Tip | Açıklama |
---|---|
dict
|
Her anahtarın bir parametre adı olduğu ve her değerin o parametrenin varsayılan değeri olduğu bir sözlük. |
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.get_ubuntu_version()
İşletim sistemi Ubuntu ise Ubuntu sürümünü alın.
İade:
Tip | Açıklama |
---|---|
str
|
Ubuntu sürümü veya Ubuntu işletim sistemi değilse Yok. |
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.get_user_config_dir(sub_dir='Ultralytics')
Ortam işletim sistemine bağlı olarak uygun yapılandırma dizinini döndürür.
Parametreler:
İsim | Tip | Açıklama | Varsayılan |
---|---|---|---|
sub_dir |
str
|
Oluşturulacak alt dizinin adı. |
'Ultralytics'
|
İade:
Tip | Açıklama |
---|---|
Path
|
Kullanıcı yapılandırma dizininin yolu. |
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.colorstr(*input)
Sağlanan renk ve stil bağımsız değişkenlerine göre bir dizeyi renklendirir. ANSI kaçış kodlarını kullanır. Daha fazla ayrıntı için https://en.wikipedia.org/wiki/ANSI_escape_code adresine bakın.
Bu işlev iki şekilde çağrılabilir
- colorstr('color', 'style', 'your string')
- colorstr('dizeniz')
İkinci formda, 'mavi' ve 'kalın' varsayılan olarak uygulanacaktır.
Parametreler:
İsim | Tip | Açıklama | Varsayılan |
---|---|---|---|
*input |
str
|
İlk n-1 dizesinin renk ve stil bağımsız değişkenleri olduğu bir dizeler dizisi, ve son dize renklendirilecek olandır. |
()
|
Desteklenen Renkler ve Stiller
Temel Renkler: 'siyah', 'kırmızı', 'yeşil', 'sarı', 'mavi', 'macenta', 'cyan', 'beyaz' Parlak Renkler: 'parlak_siyah', 'parlak_kırmızı', 'parlak_yeşil', 'parlak_sarı', 'bright_blue', 'bright_magenta', 'bright_cyan', 'bright_white' Çeşitli: 'son', 'kalın', 'altı çizili'
İade:
Tip | Açıklama |
---|---|
str
|
Belirtilen renk ve stil için ANSI kaçış kodlarıyla sarılmış giriş dizesi. |
Örnekler:
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.remove_colorstr(input_string)
Bir dizeden ANSI kaçış kodlarını kaldırarak dizenin renklendirmesini etkin bir şekilde kaldırır.
Parametreler:
İsim | Tip | Açıklama | Varsayılan |
---|---|---|---|
input_string |
str
|
Renk ve stilin kaldırılacağı dize. |
gerekli |
İade:
Tip | Açıklama |
---|---|
str
|
Tüm ANSI kaçış kodları kaldırılmış yeni bir dize. |
Örnekler:
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.threaded(func)
Varsayılan olarak bir hedef işlevi çok iş parçacıklı hale getirir ve iş parçacığı veya işlev sonucunu döndürür.
threaded dekoratörü olarak kullanın. 'threaded=False' geçilmediği sürece fonksiyon ayrı bir iş parçacığında çalışır.
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.set_sentry()
Hata izleme ve raporlama için Sentry SDK'yı başlatın. Yalnızca sentry_sdk paketi yüklüyse ve ayarlarda sync=True. Ayarlar YAML dosyasını görmek ve güncellemek için 'yolo settings' çalıştırın.
Hata göndermek için gereken koşullar (TÜM koşulların karşılanması gerekir, aksi takdirde hiçbir hata bildirilmez): - sentry_sdk paketi yüklü - YOLO ayarlarında sync=True - pytest çalışmıyor - pip paketi kurulumunda çalıştırma - git olmayan bir dizinde çalıştırma - rütbe -1 veya 0 ile çalışan - çevrimiçi ortam - CLI paketi çalıştırmak için kullanılır (ana CLI komutunun adı olarak 'yolo' ile kontrol edilir)
İşlev ayrıca Sentry SDK'yı KeyboardInterrupt ve FileNotFoundError öğelerini yok sayacak şekilde yapılandırır istisnalarını ve istisna mesajında 'bellek yetersiz' yazan olayları hariç tutmak için.
Ayrıca, fonksiyon Sentry olayları için özel etiketler ve kullanıcı bilgileri ayarlar.
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.deprecation_warn(arg, new_arg, version=None)
Kullanımdan kaldırılmış bir bağımsız değişken kullanıldığında, güncelleştirilmiş bir bağımsız değişken öneren bir kullanımdan kaldırma uyarısı yayınlayın.
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.clean_url(url)
URL'den kimlik doğrulamasını kaldırın, yani https://url.com/file.txt?auth -> https://url.com/file.txt.
Kaynak kodu ultralytics/utils/__init__.py
ultralytics.utils.url2file(url)
Oluşturuldu 2023-11-12, Güncellendi 2024-05-08
Yazarlar: Burhan-Q (1), glenn-jocher (8), Laughing-q (1)