Ссылка для ultralytics/utils/checks.py
Примечание
Этот файл доступен по адресу https://github.com/ultralytics/ ultralytics/blob/main/ ultralytics/utils/checks .py. Если ты заметил проблему, пожалуйста, помоги исправить ее, отправив Pull Request 🛠️. Спасибо 🙏!
ultralytics.utils.checks.parse_requirements(file_path=ROOT.parent / 'requirements.txt', package='')
Разбери файл requirements.txt, игнорируя строки, начинающиеся с '#', и любой текст после '#'.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
file_path |
Path
|
Путь к файлу requirements.txt. |
parent / 'requirements.txt'
|
package |
str
|
Python Пакет, который нужно использовать вместо файла requirements.txt, то есть package='ultralytics'. |
''
|
Возвращается:
Тип | Описание |
---|---|
List[Dict[str, str]]
|
Список разобранных требований в виде словарей с |
Пример
Исходный код в ultralytics/utils/checks.py
ultralytics.utils.checks.parse_version(version='0.0.0')
Преобразуй строку версии в кортеж целых чисел, игнорируя все дополнительные нечисловые строки, присоединенные к версии. Эта функция заменяет устаревшую 'pkg_resources.parse_version(v)'.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
version |
str
|
Строка версии, то есть '2.0.1+cpu'. |
'0.0.0'
|
Возвращается:
Тип | Описание |
---|---|
tuple
|
Кортеж целых чисел, представляющих числовую часть версии и дополнительную строку, то есть (2, 0, 1) |
Исходный код в ultralytics/utils/checks.py
ultralytics.utils.checks.is_ascii(s)
Проверь, состоит ли строка только из символов ASCII.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
s |
str
|
Строка, которую нужно проверить. |
требуется |
Возвращается:
Тип | Описание |
---|---|
bool
|
True, если строка состоит только из ASCII-символов, False - в противном случае. |
Исходный код в ultralytics/utils/checks.py
ultralytics.utils.checks.check_imgsz(imgsz, stride=32, min_dim=1, max_dim=2, floor=0)
Проверь, что размер изображения кратен заданному страйду в каждом измерении. Если размер изображения не кратен stride, обнови его до ближайшего кратного stride, которое больше или равно заданному значению пола.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
imgsz |
int | cList[int]
|
Размер изображения. |
требуется |
stride |
int
|
Значение страйда. |
32
|
min_dim |
int
|
Минимальное количество размеров. |
1
|
max_dim |
int
|
Максимальное количество размеров. |
2
|
floor |
int
|
Минимально допустимое значение для размера изображения. |
0
|
Возвращается:
Тип | Описание |
---|---|
List[int]
|
Обновил размер изображения. |
Исходный код в ultralytics/utils/checks.py
ultralytics.utils.checks.check_version(current='0.0.0', required='0.0.0', name='version', hard=False, verbose=False, msg='')
Сверь текущую версию с нужной версией или диапазоном.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
current |
str
|
Текущая версия или имя пакета, из которого нужно получить версию. |
'0.0.0'
|
required |
str
|
Требуемая версия или диапазон (в формате pip-style). |
'0.0.0'
|
name |
str
|
Имя, которое будет использоваться в предупреждающем сообщении. |
'version'
|
hard |
bool
|
Если True, поднимай AssertionError, если требование не выполнено. |
False
|
verbose |
bool
|
Если True, выведи предупреждение, если требование не выполнено. |
False
|
msg |
str
|
Дополнительное сообщение, которое нужно вывести на экран, если речь идет о verbose. |
''
|
Возвращается:
Тип | Описание |
---|---|
bool
|
True, если требование выполнено, False в противном случае. |
Пример
# Check if current version is exactly 22.04
check_version(current='22.04', required='==22.04')
# Check if current version is greater than or equal to 22.04
check_version(current='22.10', required='22.04') # assumes '>=' inequality if none passed
# Check if current version is less than or equal to 22.04
check_version(current='22.04', required='<=22.04')
# Check if current version is between 20.04 (inclusive) and 22.04 (exclusive)
check_version(current='21.10', required='>20.04,<22.04')
Исходный код в ultralytics/utils/checks.py
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ultralytics.utils.checks.check_latest_pypi_version(package_name='ultralytics')
Возвращает последнюю версию пакета PyPI, не скачивая и не устанавливая его.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
package_name |
str
|
Название пакета, для которого нужно найти последнюю версию. |
'ultralytics'
|
Возвращается:
Тип | Описание |
---|---|
str
|
Самая последняя версия пакета. |
Исходный код в ultralytics/utils/checks.py
ultralytics.utils.checks.check_pip_update_available()
Проверяет, доступна ли на PyPI новая версия пакета ultralytics .
Возвращается:
Тип | Описание |
---|---|
bool
|
True, если обновление доступно, False в противном случае. |
Исходный код в ultralytics/utils/checks.py
ultralytics.utils.checks.check_font(font='Arial.ttf')
Найди шрифт локально или загрузи в конфигурационную директорию пользователя, если она еще не существует.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
font |
str
|
Путь или название шрифта. |
'Arial.ttf'
|
Возвращается:
Имя | Тип | Описание |
---|---|---|
file |
Path
|
Решен вопрос с путем к файлу шрифта. |
Исходный код в ultralytics/utils/checks.py
ultralytics.utils.checks.check_python(minimum='3.8.0')
Проверь текущую версию python на соответствие требуемой минимальной версии.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
minimum |
str
|
Требуемая минимальная версия python. |
'3.8.0'
|
Возвращается:
Тип | Описание |
---|---|
bool
|
Соответствует ли установленная версия Python минимальным ограничениям. |
Исходный код в ultralytics/utils/checks.py
ultralytics.utils.checks.check_requirements(requirements=ROOT.parent / 'requirements.txt', exclude=(), install=True, cmds='')
Проверь, соответствуют ли установленные зависимости требованиям YOLOv8 , и при необходимости попытайся провести автообновление.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
requirements |
Union[Path, str, List[str]]
|
Путь к файлу requirements.txt, одному требованию пакета в виде строки строка, или список требований пакета в виде строк. |
parent / 'requirements.txt'
|
exclude |
Tuple[str]
|
Кортеж имен пакетов, которые нужно исключить из проверки. |
()
|
install |
bool
|
Если True, то попытайся автоматически обновить пакеты, которые не соответствуют требованиям. |
True
|
cmds |
str
|
Дополнительные команды, которые нужно передать команде pip install при автообновлении. |
''
|
Пример
Исходный код в ultralytics/utils/checks.py
ultralytics.utils.checks.check_torchvision()
Проверь установленные версии PyTorch и Torchvision, чтобы убедиться в их совместимости.
Эта функция проверяет установленные версии PyTorch и Torchvision и предупреждает, если они несовместимы, согласно согласно предоставленной таблице совместимости, основанной на: https://github.com/pytorch/vision#installation.
Таблица совместимости - это словарь, в котором ключами являются версии PyTorch , а значениями - списки совместимых Torchvision.
Исходный код в ultralytics/utils/checks.py
ultralytics.utils.checks.check_suffix(file='yolov8n.pt', suffix='.pt', msg='')
Проверь файл(ы) на наличие приемлемого суффикса.
Исходный код в ultralytics/utils/checks.py
ultralytics.utils.checks.check_yolov5u_filename(file, verbose=True)
Замени устаревшие имена файлов YOLOv5 на обновленные имена файлов YOLOv5u.
Исходный код в ultralytics/utils/checks.py
ultralytics.utils.checks.check_model_file_from_stem(model='yolov8n')
Верни имя файла модели из валидного стебля модели.
Исходный код в ultralytics/utils/checks.py
ultralytics.utils.checks.check_file(file, suffix='', download=True, hard=True)
Поиск/загрузка файла (если необходимо) и возврат пути.
Исходный код в ultralytics/utils/checks.py
ultralytics.utils.checks.check_yaml(file, suffix=('.yaml', '.yml'), hard=True)
Найди/загрузи YAML-файл (если нужно) и верни путь, проверив суффикс.
ultralytics.utils.checks.check_is_path_safe(basedir, path)
Проверь, находится ли разрешенный путь под предполагаемой директорией, чтобы предотвратить обход путей.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
basedir |
Path | str
|
Предполагаемая директория. |
требуется |
path |
Path | str
|
Путь, который нужно проверить. |
требуется |
Возвращается:
Тип | Описание |
---|---|
bool
|
True, если путь безопасен, False в противном случае. |
Исходный код в ultralytics/utils/checks.py
ultralytics.utils.checks.check_imshow(warn=False)
Проверь, поддерживает ли среда отображение изображений.
Исходный код в ultralytics/utils/checks.py
ultralytics.utils.checks.check_yolo(verbose=True, device='')
Верни человекочитаемый YOLO с кратким описанием программного и аппаратного обеспечения.
Исходный код в ultralytics/utils/checks.py
ultralytics.utils.checks.collect_system_info()
Собери и распечатай соответствующую системную информацию, включая ОС, Python, ОЗУ, CPU и CUDA.
Исходный код в ultralytics/utils/checks.py
ultralytics.utils.checks.check_amp(model)
YOLOv8 Эта функция проверяет работоспособность модели PyTorch Automatic Mixed Precision (AMP). Если проверка не удалась, это означает, что в системе есть аномалии с AMP, которые могут привести к NaN-потерям или результатам с нулевой MAP, поэтому AMP будет отключена во время обучения. будет отключена на время обучения.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
model |
Module
|
Экземпляр модели YOLOv8 . |
требуется |
Пример
Возвращается:
Тип | Описание |
---|---|
bool
|
Возвращает True, если функционал AMP корректно работает с моделью YOLOv8 , иначе False. |
Исходный код в ultralytics/utils/checks.py
ultralytics.utils.checks.git_describe(path=ROOT)
Верни человекочитаемое git-описание, например v5.0-5-g3e25f1e https://git-scm.com/docs/git-describe.
Исходный код в ultralytics/utils/checks.py
ultralytics.utils.checks.print_args(args=None, show_file=True, show_func=False)
Выведи аргументы функции (необязательный диктант args).
Исходный код в ultralytics/utils/checks.py
ultralytics.utils.checks.cuda_device_count()
Получи количество графических процессоров NVIDIA, доступных в окружении.
Возвращается:
Тип | Описание |
---|---|
int
|
Количество доступных графических процессоров NVIDIA. |
Исходный код в ultralytics/utils/checks.py
ultralytics.utils.checks.cuda_is_available()
Проверь, доступна ли CUDA в окружении.
Возвращается:
Тип | Описание |
---|---|
bool
|
True, если доступен один или несколько графических процессоров NVIDIA, False - в противном случае. |