Referenz fĂŒr ultralytics/utils/__init__.py
Hinweis
Diese Datei ist verfĂŒgbar unter https://github.com/ultralytics/ ultralytics/blob/main/ ultralytics/utils/init.py. Wenn du ein Problem entdeckst, hilf bitte, es zu beheben, indem du einen Pull Request đ ïž einreichst. Vielen Dank đ!
ultralytics.utils.TQDM
Basen: tqdm
Benutzerdefinierte Ultralytics tqdm-Klasse mit verschiedenen Standardargumenten.
Parameter:
Name | Typ | Beschreibung | Standard |
---|---|---|---|
*args |
list
|
Positionale Argumente, die an das ursprĂŒngliche tqdm ĂŒbergeben werden. |
()
|
**kwargs |
any
|
SchlĂŒsselwortargumente, wobei benutzerdefinierte Standardwerte angewendet werden. |
{}
|
Quellcode in ultralytics/utils/__init__.py
__init__(*args, **kwargs)
Initialisiere die benutzerdefinierte Ultralytics tqdm-Klasse mit verschiedenen Standardargumenten.
Beachte, dass diese beim Aufruf von TQDM ĂŒberschrieben werden können.
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.SimpleClass
Ultralytics SimpleClass ist eine Basisklasse, die hilfreiche Methoden zur String-Darstellung, Fehlerberichterstattung und Attribut Zugriffsmethoden fĂŒr eine einfachere Fehlersuche und Verwendung.
Quellcode in ultralytics/utils/__init__.py
__getattr__(attr)
Benutzerdefinierte Attribut-Zugriffsfehlermeldung mit hilfreichen Informationen.
__repr__()
__str__()
Gibt eine menschenlesbare String-ReprĂ€sentation des Objekts zurĂŒck.
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.IterableSimpleNamespace
Basen: SimpleNamespace
Ultralytics IterableSimpleNamespace ist eine Erweiterungsklasse von SimpleNamespace, die die FunktionalitÀt von Iterables und die Verwendung mit dict() und for-Schleifen ermöglicht.
Quellcode in ultralytics/utils/__init__.py
__getattr__(attr)
Benutzerdefinierte Attribut-Zugriffsfehlermeldung mit hilfreichen Informationen.
Quellcode in ultralytics/utils/__init__.py
__iter__()
__str__()
get(key, default=None)
Gibt den Wert des angegebenen SchlĂŒssels zurĂŒck, wenn er existiert; andernfalls wird der Standardwert zurĂŒckgegeben.
ultralytics.utils.ThreadingLocked
Eine Dekoratorklasse, die eine thread-sichere AusfĂŒhrung einer Funktion oder Methode gewĂ€hrleistet. Diese Klasse kann als Dekorator verwendet werden verwendet werden, um sicherzustellen, dass bei einem Aufruf der dekorierten Funktion von mehreren Threads aus jeweils nur ein Thread in der Lage sein wird die Funktion ausfĂŒhren kann.
Attribute:
Name | Typ | Beschreibung |
---|---|---|
lock |
Lock
|
Ein Sperrobjekt, das den Zugriff auf die dekorierte Funktion verwaltet. |
Beispiel
Quellcode in ultralytics/utils/__init__.py
__call__(f)
Thread-sichere AusfĂŒhrung einer Funktion oder Methode.
Quellcode in ultralytics/utils/__init__.py
__init__()
ultralytics.utils.TryExcept
Basen: ContextDecorator
Ultralytics TryExcept-Klasse. Verwende als @TryExcept() Dekorator oder 'with TryExcept():' Kontextmanager.
Beispiele:
Als Dekorateur:
>>> @TryExcept(msg="Error occurred in func", verbose=True)
>>> def func():
>>> # Function logic here
>>> pass
Als Kontextmanager:
Quellcode in ultralytics/utils/__init__.py
__enter__()
__exit__(exc_type, value, traceback)
Legt das Verhalten beim Verlassen eines "with"-Blocks fest und gibt ggf. eine Fehlermeldung aus.
__init__(msg='', verbose=True)
Initialisiere die TryExcept-Klasse mit optionalen Nachrichten- und Verbosity-Einstellungen.
ultralytics.utils.Retry
Basen: ContextDecorator
Wiederholungsklasse fĂŒr die FunktionsausfĂŒhrung mit exponentiellem Backoff.
Kann als Dekorator oder als Kontextmanager verwendet werden, um eine Funktion oder einen Codeblock bei Ausnahmen bis zu einer Anzahl von Wiederholungen mit einer exponentiell ansteigenden Verzögerung zwischen den Wiederholungen.
Beispiele:
Beispiel fĂŒr die Verwendung als Dekorator:
>>> @Retry(times=3, delay=2)
>>> def test_func():
>>> # Replace with function logic that may raise exceptions
>>> return True
Beispiel fĂŒr die Verwendung als Kontextmanager:
Quellcode in ultralytics/utils/__init__.py
__call__(func)
Decorator-Implementierung fĂŒr Retry mit exponentiellem Backoff.
Quellcode in ultralytics/utils/__init__.py
__enter__()
__exit__(exc_type, exc_value, traceback)
Beende den Laufzeitkontext fĂŒr dieses Objekt mit exponentiellem Backoff.
Quellcode in ultralytics/utils/__init__.py
__init__(times=3, delay=2)
Initialisiere die Retry-Klasse mit der angegebenen Anzahl von Wiederholungen und der Verzögerung.
ultralytics.utils.SettingsManager
Basen: dict
Verwaltet die Ultralytics Einstellungen, die in einer YAML-Datei gespeichert sind.
Parameter:
Name | Typ | Beschreibung | Standard |
---|---|---|---|
file |
str | Path
|
Pfad zur Ultralytics settings YAML-Datei. Der Standardwert ist USER_CONFIG_DIR / 'settings.yaml'. |
SETTINGS_YAML
|
version |
str
|
Version der Einstellungen. Wenn die lokale Version nicht ĂŒbereinstimmt, werden die neuen Standardeinstellungen gespeichert. |
'0.0.4'
|
Quellcode in 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')
Initialisiere den SettingsManager mit den Standardeinstellungen, lade und validiere die aktuellen Einstellungen aus der YAML Datei.
Quellcode in ultralytics/utils/__init__.py
load()
reset()
save()
ultralytics.utils.plt_settings(rcparams=None, backend='Agg')
Decorator zum temporĂ€ren Setzen von rc-Parametern und des Backends fĂŒr eine Plotting-Funktion.
Beispiel
decorator: @plt_settings({"font.size": 12}) context manager: with plt_settings({"font.size": 12}):
Parameter:
Name | Typ | Beschreibung | Standard |
---|---|---|---|
rcparams |
dict
|
Wörterbuch der zu setzenden rc-Parameter. |
None
|
backend |
str
|
Name des zu verwendenden Backends. Der Standardwert ist "Agg". |
'Agg'
|
Retouren:
Typ | Beschreibung |
---|---|
Callable
|
Dekorierte Funktion mit temporĂ€r gesetzten rc-Parametern und Backend. Dieser Decorator kann auf jede Funktion angewendet werden, die fĂŒr ihre AusfĂŒhrung bestimmte matplotlib rc-Parameter und ein Backend benötigt. |
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.set_logging(name='LOGGING_NAME', verbose=True)
Richtet die Protokollierung fĂŒr den angegebenen Namen mit UnterstĂŒtzung der UTF-8-Kodierung ein, um die KompatibilitĂ€t zwischen verschiedenen Umgebungen gewĂ€hrleistet.
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.emojis(string='')
ultralytics.utils.yaml_save(file='data.yaml', data=None, header='')
Speichere YAML-Daten in einer Datei.
Parameter:
Name | Typ | Beschreibung | Standard |
---|---|---|---|
file |
str
|
Dateiname. Der Standard ist "data.yaml". |
'data.yaml'
|
data |
dict
|
Zu speichernde Daten im YAML-Format. |
None
|
header |
str
|
YAML-Header zum HinzufĂŒgen. |
''
|
Retouren:
Typ | Beschreibung |
---|---|
None
|
Die Daten werden in der angegebenen Datei gespeichert. |
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.yaml_load(file='data.yaml', append_filename=False)
Lade YAML-Daten aus einer Datei.
Parameter:
Name | Typ | Beschreibung | Standard |
---|---|---|---|
file |
str
|
Dateiname. Der Standard ist "data.yaml". |
'data.yaml'
|
append_filename |
bool
|
FĂŒgt den YAML-Dateinamen in das YAML-Wörterbuch ein. Standard ist False. |
False
|
Retouren:
Typ | Beschreibung |
---|---|
dict
|
YAML-Daten und Dateiname. |
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.yaml_print(yaml_file)
Pretty gibt eine YAML-Datei oder ein YAML-formatiertes Wörterbuch aus.
Parameter:
Name | Typ | Beschreibung | Standard |
---|---|---|---|
yaml_file |
Union[str, Path, dict]
|
Der Dateipfad der YAML-Datei oder eines YAML-formatierten Wörterbuchs. |
erforderlich |
Retouren:
Typ | Beschreibung |
---|---|
None
|
(Keine) |
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.read_device_model()
Liest die GerĂ€temodellinformationen aus dem System und speichert sie fĂŒr einen schnellen Zugriff. Wird von is_jetson() und is_raspberrypi().
Retouren:
Typ | Beschreibung |
---|---|
str
|
Inhalt der Modelldatei, wenn sie erfolgreich gelesen wurde, sonst leerer String. |
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.is_ubuntu()
PrĂŒfe, ob das Betriebssystem Ubuntu ist.
Retouren:
Typ | Beschreibung |
---|---|
bool
|
True, wenn das Betriebssystem Ubuntu ist, sonst False. |
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.is_colab()
PrĂŒfe, ob das aktuelle Skript in einem Google Colab-Notizbuch ausgefĂŒhrt wird.
Retouren:
Typ | Beschreibung |
---|---|
bool
|
True, wenn es in einem Colab-Notebook lÀuft, sonst False. |
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.is_kaggle()
PrĂŒfe, ob das aktuelle Skript in einem Kaggle-Kernel lĂ€uft.
Retouren:
Typ | Beschreibung |
---|---|
bool
|
True, wenn es in einem Kaggle-Kernel lÀuft, sonst False. |
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.is_jupyter()
ĂberprĂŒfe, ob das aktuelle Skript in einem Jupyter Notebook lĂ€uft. Verifiziert auf Colab, Jupyterlab, Kaggle, Paperspace.
Retouren:
Typ | Beschreibung |
---|---|
bool
|
True, wenn es in einem Jupyter Notebook lÀuft, sonst False. |
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.is_docker()
Stelle fest, ob das Skript in einem Docker-Container lÀuft.
Retouren:
Typ | Beschreibung |
---|---|
bool
|
True, wenn das Skript in einem Docker-Container lÀuft, sonst False. |
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.is_raspberrypi()
Ermittelt, ob die Umgebung Python auf einem Raspberry Pi lĂ€uft, indem er die Informationen zum GerĂ€temodell ĂŒberprĂŒft.
Retouren:
Typ | Beschreibung |
---|---|
bool
|
True, wenn es auf einem Raspberry Pi lÀuft, sonst False. |
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.is_jetson()
Ermittelt, ob die Umgebung Python auf einem Jetson Nano oder Jetson Orin GerÀt lÀuft, indem die GerÀtemodell Informationen.
Retouren:
Typ | Beschreibung |
---|---|
bool
|
True, wenn es auf einem Jetson Nano oder Jetson Orin lÀuft, sonst False. |
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.is_online()
ĂberprĂŒfe die Internetverbindung, indem du versuchst, dich mit einem bekannten Online-Host zu verbinden.
Retouren:
Typ | Beschreibung |
---|---|
bool
|
True, wenn die Verbindung erfolgreich ist, sonst False. |
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.is_pip_package(filepath=__name__)
Ermittelt, ob die Datei im angegebenen Dateipfad Teil eines pip-Pakets ist.
Parameter:
Name | Typ | Beschreibung | Standard |
---|---|---|---|
filepath |
str
|
Der zu prĂŒfende Dateipfad. |
__name__
|
Retouren:
Typ | Beschreibung |
---|---|
bool
|
True, wenn die Datei Teil eines Pip-Pakets ist, sonst False. |
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.is_dir_writeable(dir_path)
PrĂŒfe, ob ein Verzeichnis beschreibbar ist.
Parameter:
Name | Typ | Beschreibung | Standard |
---|---|---|---|
dir_path |
str | Path
|
Der Pfad zum Verzeichnis. |
erforderlich |
Retouren:
Typ | Beschreibung |
---|---|
bool
|
True, wenn das Verzeichnis beschreibbar ist, sonst False. |
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.is_pytest_running()
Ermittelt, ob pytest gerade lÀuft oder nicht.
Retouren:
Typ | Beschreibung |
---|---|
bool
|
True, wenn pytest lÀuft, sonst False. |
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.is_github_action_running()
Stelle fest, ob die aktuelle Umgebung ein GitHub Actions Runner ist.
Retouren:
Typ | Beschreibung |
---|---|
bool
|
True, wenn die aktuelle Umgebung ein GitHub Actions Runner ist, sonst False. |
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.get_git_dir()
Ermittelt, ob die aktuelle Datei Teil eines Git-Repositorys ist, und gibt, falls ja, das Stammverzeichnis des Repositorys zurĂŒck. Wenn die aktuelle Datei nicht Teil eines Git-Repositorys ist, wird None zurĂŒckgegeben.
Retouren:
Typ | Beschreibung |
---|---|
Path | None
|
Git-Stammverzeichnis, wenn es gefunden wurde, oder None, wenn es nicht gefunden wurde. |
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.is_git_dir()
Ermittelt, ob die aktuelle Datei Teil eines Git-Repositorys ist. Wenn die aktuelle Datei nicht Teil eines Git Repository ist, wird None zurĂŒckgegeben.
Retouren:
Typ | Beschreibung |
---|---|
bool
|
Wahr, wenn die aktuelle Datei Teil eines Git-Repositorys ist. |
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.get_git_origin_url()
Ruft die Ursprungs-URL eines Git-Repositorys ab.
Retouren:
Typ | Beschreibung |
---|---|
str | None
|
Die Ursprungs-URL des Git-Repositorys oder Keine, wenn es sich nicht um ein Git-Verzeichnis handelt. |
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.get_git_branch()
Gibt den Namen des aktuellen Git-Zweigs zurĂŒck. Wenn kein Git-Repository vorhanden ist, wird None zurĂŒckgegeben.
Retouren:
Typ | Beschreibung |
---|---|
str | None
|
Der Name des aktuellen Git-Zweigs oder None, wenn es sich nicht um ein Git-Verzeichnis handelt. |
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.get_default_args(func)
Gibt ein Wörterbuch mit Standardargumenten fĂŒr eine Funktion zurĂŒck.
Parameter:
Name | Typ | Beschreibung | Standard |
---|---|---|---|
func |
callable
|
Die zu prĂŒfende Funktion. |
erforderlich |
Retouren:
Typ | Beschreibung |
---|---|
dict
|
Ein Wörterbuch, in dem jeder SchlĂŒssel ein Parametername und jeder Wert der Standardwert dieses Parameters ist. |
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.get_ubuntu_version()
Rufe die Ubuntu-Version ab, wenn das Betriebssystem Ubuntu ist.
Retouren:
Typ | Beschreibung |
---|---|
str
|
Ubuntu-Version oder Keine, wenn du kein Ubuntu-Betriebssystem hast. |
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.get_user_config_dir(sub_dir='Ultralytics')
Gibt das entsprechende Konfigurationsverzeichnis zurĂŒck, das auf dem Betriebssystem der Umgebung basiert.
Parameter:
Name | Typ | Beschreibung | Standard |
---|---|---|---|
sub_dir |
str
|
Der Name des zu erstellenden Unterverzeichnisses. |
'Ultralytics'
|
Retouren:
Typ | Beschreibung |
---|---|
Path
|
Der Pfad zum Verzeichnis der Benutzerkonfiguration. |
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.colorstr(*input)
FĂ€rbt eine Zeichenkette basierend auf den angegebenen Farb- und Stilargumenten. Verwendet ANSI-Escape-Codes. Siehe https://en.wikipedia.org/wiki/ANSI_escape_code fĂŒr weitere Details.
Diese Funktion kann auf zwei Arten aufgerufen werden
- colorstr('color', 'style', 'your string')
- colorstr('dein String')
In der zweiten Form werden standardmĂ€Ăig "blau" und "fett" verwendet.
Parameter:
Name | Typ | Beschreibung | Standard |
---|---|---|---|
*input |
str
|
Eine Folge von Strings, wobei die ersten n-1 Strings Farb- und Stilargumente sind, und die letzte Zeichenkette diejenige ist, die gefÀrbt werden soll. |
()
|
UnterstĂŒtzte Farben und Stile
Grundfarben: 'schwarz', 'rot', 'grĂŒn', 'gelb', 'blau', 'magenta', 'cyan', 'weiĂ' Leuchtende Farben: 'bright_black', 'bright_red', 'bright_green', 'bright_yellow', 'bright_blue', 'bright_magenta', 'bright_cyan', 'bright_white' Sonstiges: 'end', 'bold', 'underline'
Retouren:
Typ | Beschreibung |
---|---|
str
|
Der Eingabestring wird mit ANSI-Escape-Codes fĂŒr die angegebene Farbe und den Stil umbrochen. |
Beispiele:
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.remove_colorstr(input_string)
Entfernt ANSI-Escape-Codes aus einer Zeichenkette, sodass sie nicht mehr eingefÀrbt wird.
Parameter:
Name | Typ | Beschreibung | Standard |
---|---|---|---|
input_string |
str
|
Der String, aus dem Farbe und Stil entfernt werden sollen. |
erforderlich |
Retouren:
Typ | Beschreibung |
---|---|
str
|
Ein neuer String, bei dem alle ANSI-Escape-Codes entfernt wurden. |
Beispiele:
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.threaded(func)
Multithreadet eine Zielfunktion standardmĂ€Ăig und gibt das Ergebnis des Threads oder der Funktion zurĂŒck.
Verwendung als @threaded Dekorator. Die Funktion wird in einem separaten Thread ausgefĂŒhrt, es sei denn, es wird 'threaded=False' ĂŒbergeben.
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.set_sentry()
Initialisiere das Sentry SDK fĂŒr die Fehlerverfolgung und -meldung. Wird nur verwendet, wenn das Paket sentry_sdk installiert ist und sync=True in den Einstellungen. FĂŒhre 'yolo settings' aus, um die YAML-Datei mit den Einstellungen anzuzeigen und zu aktualisieren.
Erforderliche Bedingungen, um Fehler zu senden (ALLE Bedingungen mĂŒssen erfĂŒllt sein, sonst werden keine Fehler gemeldet): - sentry_sdk-Paket ist installiert - sync=True in den Einstellungen von YOLO - pytest wird nicht ausgefĂŒhrt - lĂ€uft in einer pip-Paketinstallation - lĂ€uft in einem Nicht-Git-Verzeichnis - mit Rang -1 oder 0 ausgefĂŒhrt wird - Online-Umgebung - CLI verwendet, um das Paket auszufĂŒhren (ĂŒberprĂŒft mit 'yolo' als Name des Hauptbefehls CLI )
Die Funktion konfiguriert Sentry SDK auĂerdem so, dass es die Ausnahmen KeyboardInterrupt und FileNotFoundError Ausnahmen zu ignorieren und Ereignisse mit "out of memory" in der Ausnahmemeldung auszuschlieĂen.
AuĂerdem setzt die Funktion benutzerdefinierte Tags und Benutzerinformationen fĂŒr Sentry-Ereignisse.
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.deprecation_warn(arg, new_arg, version=None)
Gib eine Verwerfungswarnung aus, wenn ein veraltetes Argument verwendet wird, und schlage ein aktualisiertes Argument vor.
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.clean_url(url)
Entferne die Autorisierung aus der URL, d.h. https://url.com/file.txt?auth -> https://url.com/file.txt.
Quellcode in ultralytics/utils/__init__.py
ultralytics.utils.url2file(url)
Erstellt am 2023-11-12, Aktualisiert am 2024-05-08
Autoren: Burhan-Q (1), glenn-jocher (8), Laughing-q (1)