Référence pour ultralytics/utils/__init__.py
Note
Ce fichier est disponible à l'adresse https://github.com/ultralytics/ ultralytics/blob/main/ ultralytics/utils/init.py. Si tu repères un problème, aide à le corriger en contribuant à une Pull Request 🛠️. Merci 🙏 !
ultralytics.utils.TQDM
Bases : tqdm
Classe Ultralytics tqdm personnalisée avec différents arguments par défaut.
Paramètres :
Nom | Type | Description | DĂ©faut |
---|---|---|---|
*args |
list
|
Arguments de position transmis au tqdm d'origine. |
()
|
**kwargs |
any
|
Arguments de mots-clés, avec des valeurs par défaut personnalisées. |
{}
|
Code source dans ultralytics/utils/__init__.py
__init__(*args, **kwargs)
Initialise la classe personnalisée Ultralytics tqdm avec différents arguments par défaut.
Note qu'ils peuvent toujours être remplacés lors de l'appel à TQDM.
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.SimpleClass
Ultralytics SimpleClass est une classe de base qui fournit une représentation utile des chaînes de caractères, des rapports d'erreurs et des méthodes d'accès aux attributs pour faciliter le débogage et l'utilisation. pour faciliter le débogage et l'utilisation.
Code source dans ultralytics/utils/__init__.py
__getattr__(attr)
Message d'erreur d'accès aux attributs personnalisé avec des informations utiles.
Code source dans ultralytics/utils/__init__.py
__repr__()
__str__()
Renvoie une représentation sous forme de chaîne de caractères lisible par l'homme de l'objet.
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.IterableSimpleNamespace
Bases : SimpleNamespace
Ultralytics IterableSimpleNamespace est une classe d'extension de SimpleNamespace qui ajoute la fonctionnalité itérable et permet l'utilisation de dict() et de boucles for. et permet de l'utiliser avec dict() et les boucles for.
Code source dans ultralytics/utils/__init__.py
__getattr__(attr)
Message d'erreur d'accès aux attributs personnalisé avec des informations utiles.
Code source dans ultralytics/utils/__init__.py
__iter__()
__str__()
Renvoie une représentation sous forme de chaîne de caractères lisible par l'homme de l'objet.
get(key, default=None)
Renvoie la valeur de la clé spécifiée si elle existe ; sinon, renvoie la valeur par défaut.
ultralytics.utils.ThreadingLocked
Une classe décoratrice pour garantir l'exécution sans fil d'une fonction ou d'une méthode. Cette classe peut être utilisée comme décorateur pour s'assurer que si la fonction décorée est appelée à partir de plusieurs threads, un seul thread à la fois sera en mesure d'exécuter la fonction. exécuter la fonction.
Attributs :
Nom | Type | Description |
---|---|---|
lock |
Lock
|
Un objet de verrouillage utilisé pour gérer l'accès à la fonction décorée. |
Exemple
Code source dans ultralytics/utils/__init__.py
__call__(f)
Exécute la fonction ou la méthode de manière sûre pour les threads.
Code source dans ultralytics/utils/__init__.py
__init__()
ultralytics.utils.TryExcept
Bases : ContextDecorator
Ultralytics Classe TryExcept. À utiliser comme décorateur @TryExcept() ou comme gestionnaire de contexte 'with TryExcept():'.
Exemples :
En tant que décorateur :
>>> @TryExcept(msg="Error occurred in func", verbose=True)
>>> def func():
>>> # Function logic here
>>> pass
En tant que gestionnaire de contexte :
Code source dans ultralytics/utils/__init__.py
__enter__()
__exit__(exc_type, value, traceback)
Définit le comportement lors de la sortie d'un bloc "avec", imprime un message d'erreur si nécessaire.
Code source dans ultralytics/utils/__init__.py
__init__(msg='', verbose=True)
Initialise la classe TryExcept avec les paramètres optionnels de message et de verbosité.
ultralytics.utils.Retry
Bases : ContextDecorator
Classe de réessais pour l'exécution de fonctions avec un backoff exponentiel.
Peut être utilisé comme décorateur ou comme gestionnaire de contexte pour réessayer une fonction ou un bloc de code en cas d'exception, jusqu'à un nombre spécifié de fois avec un délai croissant de façon exponentielle entre les tentatives. jusqu'à un nombre spécifié de fois avec un délai exponentiel entre les tentatives.
Exemples :
Exemple d'utilisation en tant que décorateur :
>>> @Retry(times=3, delay=2)
>>> def test_func():
>>> # Replace with function logic that may raise exceptions
>>> return True
Exemple d'utilisation en tant que gestionnaire de contexte :
Code source dans ultralytics/utils/__init__.py
__call__(func)
Implémentation d'un décorateur pour le Retry avec backoff exponentiel.
Code source dans ultralytics/utils/__init__.py
__enter__()
__exit__(exc_type, exc_value, traceback)
Quitte le contexte d'exécution lié à cet objet avec un délai exponentiel.
Code source dans ultralytics/utils/__init__.py
__init__(times=3, delay=2)
Initialise la classe Retry avec le nombre de tentatives et le délai spécifiés.
ultralytics.utils.SettingsManager
Bases : dict
Gère les paramètres de Ultralytics stockés dans un fichier YAML.
Paramètres :
Nom | Type | Description | DĂ©faut |
---|---|---|---|
file |
str | Path
|
Chemin d'accès au fichier YAML des paramètres de Ultralytics . La valeur par défaut est USER_CONFIG_DIR / 'settings.yaml'. |
SETTINGS_YAML
|
version |
str
|
Version des paramètres. En cas d'incompatibilité de la version locale, les nouveaux paramètres par défaut seront enregistrés. |
'0.0.4'
|
Code source dans 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')
Initialise le SettingsManager avec les paramètres par défaut, charge et valide les paramètres actuels à partir du fichier YAML et les valider.
Code source dans ultralytics/utils/__init__.py
load()
reset()
save()
ultralytics.utils.plt_settings(rcparams=None, backend='Agg')
Décorateur pour définir temporairement les paramètres rc et le backend d'une fonction de traçage.
Exemple
decorator: @plt_settings({"font.size": 12}) context manager: with plt_settings({"font.size": 12}):
Paramètres :
Nom | Type | Description | DĂ©faut |
---|---|---|---|
rcparams |
dict
|
Dictionnaire des paramètres rc à définir. |
None
|
backend |
str
|
Nom du backend à utiliser. La valeur par défaut est "Agg". |
'Agg'
|
Retourne :
Type | Description |
---|---|
Callable
|
Fonction décorée avec des paramètres rc et un backend temporairement définis. Ce décorateur peut être Ce décorateur peut être appliqué à n'importe quelle fonction qui a besoin de paramètres rc et d'un backend matplotlib spécifiques pour son exécution. |
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.set_logging(name='LOGGING_NAME', verbose=True)
Configure la journalisation pour le nom donné avec la prise en charge de l'encodage UTF-8, ce qui assure la compatibilité entre différents environnements. environnements.
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.emojis(string='')
Renvoie une version de la chaîne de caractères compatible avec les emoji et dépendant de la plateforme.
ultralytics.utils.yaml_save(file='data.yaml', data=None, header='')
Sauvegarde les données YAML dans un fichier.
Paramètres :
Nom | Type | Description | DĂ©faut |
---|---|---|---|
file |
str
|
Nom du fichier. La valeur par défaut est "data.yaml". |
'data.yaml'
|
data |
dict
|
Données à enregistrer au format YAML. |
None
|
header |
str
|
En-tĂŞte YAML Ă ajouter. |
''
|
Retourne :
Type | Description |
---|---|
None
|
Les données sont enregistrées dans le fichier spécifié. |
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.yaml_load(file='data.yaml', append_filename=False)
Charge les données YAML à partir d'un fichier.
Paramètres :
Nom | Type | Description | DĂ©faut |
---|---|---|---|
file |
str
|
Nom du fichier. La valeur par défaut est "data.yaml". |
'data.yaml'
|
append_filename |
bool
|
Ajoute le nom du fichier YAML au dictionnaire YAML. La valeur par défaut est False. |
False
|
Retourne :
Type | Description |
---|---|
dict
|
Données YAML et nom du fichier. |
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.yaml_print(yaml_file)
Imprime joliment un fichier YAML ou un dictionnaire formaté en YAML.
Paramètres :
Nom | Type | Description | DĂ©faut |
---|---|---|---|
yaml_file |
Union[str, Path, dict]
|
Le chemin d'accès au fichier YAML ou à un dictionnaire formaté en YAML. |
requis |
Retourne :
Type | Description |
---|---|
None
|
(Aucun) |
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.read_device_model()
Lit les informations sur le modèle de l'appareil à partir du système et les met en cache pour un accès rapide. Utilisé par is_jetson() et is_raspberrypi().
Retourne :
Type | Description |
---|---|
str
|
Contenu du fichier modèle si la lecture a réussi ou chaîne vide dans le cas contraire. |
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.is_ubuntu()
Vérifie si le système d'exploitation est Ubuntu.
Retourne :
Type | Description |
---|---|
bool
|
True si le système d'exploitation est Ubuntu, False sinon. |
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.is_colab()
Vérifie si le script en cours s'exécute dans un carnet Google Colab.
Retourne :
Type | Description |
---|---|
bool
|
True si l'exécution se fait à l'intérieur d'un cahier Colab, False sinon. |
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.is_kaggle()
Vérifie si le script actuel s'exécute à l'intérieur d'un noyau Kaggle.
Retourne :
Type | Description |
---|---|
bool
|
True si l'exécution se fait à l'intérieur d'un noyau Kaggle, False dans le cas contraire. |
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.is_jupyter()
Vérifie si le script actuel s'exécute à l'intérieur d'un carnet Jupyter. Vérifié sur Colab, Jupyterlab, Kaggle, Paperspace.
Retourne :
Type | Description |
---|---|
bool
|
True si l'exécution se fait à l'intérieur d'un carnet Jupyter, False sinon. |
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.is_docker()
Détermine si le script s'exécute à l'intérieur d'un conteneur Docker.
Retourne :
Type | Description |
---|---|
bool
|
True si le script s'exécute à l'intérieur d'un conteneur Docker, False sinon. |
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.is_raspberrypi()
Détermine si l'environnement Python fonctionne sur un Raspberry Pi en vérifiant les informations sur le modèle de l'appareil.
Retourne :
Type | Description |
---|---|
bool
|
True s'il s'agit d'un Raspberry Pi, False dans le cas contraire. |
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.is_jetson()
Détermine si l'environnement Python est exécuté sur un appareil Jetson Nano ou Jetson Orin en vérifiant les informations sur le modèle de l'appareil. de l'appareil.
Retourne :
Type | Description |
---|---|
bool
|
True s'il fonctionne sur un Jetson Nano ou un Jetson Orin, False sinon. |
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.is_online()
Vérifie la connectivité Internet en essayant de te connecter à un hôte en ligne connu.
Retourne :
Type | Description |
---|---|
bool
|
Vrai si la connexion est réussie, Faux sinon. |
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.is_pip_package(filepath=__name__)
Détermine si le fichier situé dans le chemin d'accès donné fait partie d'un paquetage pip.
Paramètres :
Nom | Type | Description | DĂ©faut |
---|---|---|---|
filepath |
str
|
Le chemin d'accès au fichier à vérifier. |
__name__
|
Retourne :
Type | Description |
---|---|
bool
|
True si le fichier fait partie d'un paquetage pip, False sinon. |
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.is_dir_writeable(dir_path)
Vérifie si un répertoire est accessible en écriture.
Paramètres :
Nom | Type | Description | DĂ©faut |
---|---|---|---|
dir_path |
str | Path
|
Le chemin d'accès au répertoire. |
requis |
Retourne :
Type | Description |
---|---|
bool
|
Vrai si le répertoire est accessible en écriture, Faux sinon. |
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.is_pytest_running()
Détermine si pytest est actuellement en cours d'exécution ou non.
Retourne :
Type | Description |
---|---|
bool
|
True si pytest est en cours d'exécution, False sinon. |
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.is_github_action_running()
Déterminer si l'environnement actuel est un exécuteur d'actions GitHub.
Retourne :
Type | Description |
---|---|
bool
|
Vrai si l'environnement actuel est un gestionnaire d'actions GitHub, Faux dans le cas contraire. |
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.get_git_dir()
Détermine si le fichier actuel fait partie d'un dépôt git et si c'est le cas, renvoie le répertoire racine du dépôt. Si le fichier actuel ne fait pas partie d'un dépôt git, il renvoie None. le fichier actuel ne fait pas partie d'un dépôt git, il renvoie None.
Retourne :
Type | Description |
---|---|
Path | None
|
Répertoire racine de Git s'il est trouvé ou Aucun s'il n'est pas trouvé. |
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.is_git_dir()
Détermine si le fichier actuel fait partie d'un dépôt git. Si le fichier actuel ne fait pas partie d'un dépôt git il renvoie None.
Retourne :
Type | Description |
---|---|
bool
|
Vrai si le fichier actuel fait partie d'un dépôt git. |
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.get_git_origin_url()
Récupère l'URL d'origine d'un dépôt git.
Retourne :
Type | Description |
---|---|
str | None
|
L'URL d'origine du dépôt git ou Aucune si ce n'est pas le répertoire git. |
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.get_git_branch()
Renvoie le nom de la branche git actuelle. S'il ne se trouve pas dans un dépôt git, il renvoie None.
Retourne :
Type | Description |
---|---|
str | None
|
Le nom de la branche git actuelle ou None s'il ne s'agit pas d'un répertoire git. |
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.get_default_args(func)
Renvoie un dictionnaire d'arguments par défaut pour une fonction.
Paramètres :
Nom | Type | Description | DĂ©faut |
---|---|---|---|
func |
callable
|
La fonction Ă inspecter. |
requis |
Retourne :
Type | Description |
---|---|
dict
|
Un dictionnaire où chaque clé est un nom de paramètre, et chaque valeur est la valeur par défaut de ce paramètre. |
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.get_ubuntu_version()
Récupère la version Ubuntu si le système d'exploitation est Ubuntu.
Retourne :
Type | Description |
---|---|
str
|
Version Ubuntu ou Aucune si ce n'est pas un système d'exploitation Ubuntu. |
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.get_user_config_dir(sub_dir='Ultralytics')
Renvoie le répertoire de configuration approprié en fonction du système d'exploitation de l'environnement.
Paramètres :
Nom | Type | Description | DĂ©faut |
---|---|---|---|
sub_dir |
str
|
Le nom du sous-répertoire à créer. |
'Ultralytics'
|
Retourne :
Type | Description |
---|---|
Path
|
Le chemin d'accès au répertoire de configuration de l'utilisateur. |
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.colorstr(*input)
Colore une chaîne en fonction des arguments de couleur et de style fournis. Utilise les codes d'échappement ANSI. Voir https://en.wikipedia.org/wiki/ANSI_escape_code pour plus de détails.
Cette fonction peut être appelée de deux façons
- colorstr('color', 'style', 'your string')
- colorstr('ta chaîne')
Dans le deuxième formulaire, "bleu" et "gras" seront appliqués par défaut.
Paramètres :
Nom | Type | Description | DĂ©faut |
---|---|---|---|
*input |
str
|
Une séquence de chaînes où les n-1 premières chaînes sont des arguments de couleur et de style, et la dernière chaîne est celle qui doit être colorée. |
()
|
Couleurs et styles pris en charge
Couleurs de base : 'noir', 'rouge', 'vert', 'jaune', 'bleu', 'magenta', 'cyan', 'blanc'. Couleurs vives : 'bright_black', 'bright_red', 'bright_green', 'bright_yellow', 'bright_blue', 'bright_magenta', 'bright_cyan', 'bright_white' Divers : 'end', 'bold', 'underline'
Retourne :
Type | Description |
---|---|
str
|
La chaîne d'entrée est enveloppée de codes d'échappement ANSI pour la couleur et le style spécifiés. |
Exemples :
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.remove_colorstr(input_string)
Supprime les codes d'échappement ANSI d'une chaîne de caractères, ce qui permet de la décolorer.
Paramètres :
Nom | Type | Description | DĂ©faut |
---|---|---|---|
input_string |
str
|
La chaîne dont il faut retirer la couleur et le style. |
requis |
Retourne :
Type | Description |
---|---|
str
|
Une nouvelle chaîne de caractères dont tous les codes d'échappement ANSI ont été supprimés. |
Exemples :
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.threaded(func)
Multiplie les threads d'une fonction cible par défaut et renvoie le résultat du thread ou de la fonction.
Utilise le décorateur @threaded. La fonction s'exécute dans un thread séparé à moins que 'threaded=False' ne soit passé.
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.set_sentry()
Initialise le SDK Sentry pour le suivi et le signalement des erreurs. Utilisé uniquement si le paquet sentry_sdk est installé et que le paramètre sync=True dans les paramètres. Exécute 'yolo settings' pour voir et mettre à jour le fichier YAML des paramètres.
Conditions requises pour envoyer des erreurs (TOUTES les conditions doivent être remplies, sinon aucune erreur ne sera signalée) : - le paquet sentry_sdk est installé - sync=True dans les paramètres de YOLO - pytest n'est pas en cours d'exécution - s'exécute dans une installation de paquetage pip - s'exécute dans un répertoire non git - s'exécute avec un rang -1 ou 0 - environnement en ligne - CLI utilisé pour exécuter le paquet (vérifié avec 'yolo' comme nom de la commande principale CLI )
La fonction configure également Sentry SDK pour qu'il ignore les exceptions KeyboardInterrupt et FileNotFoundError et pour exclure les événements dont le message d'exception contient la mention "out of memory".
En outre, la fonction définit des étiquettes personnalisées et des informations sur l'utilisateur pour les événements Sentry.
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.deprecation_warn(arg, new_arg, version=None)
Émettre un avertissement de dépréciation lorsqu'un argument déprécié est utilisé, en suggérant un argument mis à jour.
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.clean_url(url)
Supprime l'authentification de l'URL, c'est-Ă -dire https://url.com/file.txt?auth -> https://url.com/file.txt.
Code source dans ultralytics/utils/__init__.py
ultralytics.utils.url2file(url)
Créé le 2023-11-12, Mis à jour le 2024-05-08
Auteurs : Burhan-Q (1), glenn-jocher (8), Laughing-q (1)