Ссылка для ultralytics/engine/model.py
Примечание
Этот файл доступен по адресу https://github.com/ultralytics/ ultralytics/blob/main/ ultralytics/engine/model .py. Если ты заметил проблему, пожалуйста, помоги исправить ее, отправив Pull Request 🛠️. Спасибо 🙏!
ultralytics.engine.model.Model
Базы: Module
Базовый класс для реализации моделей YOLO , унифицирующий API для разных типов моделей.
Этот класс предоставляет общий интерфейс для различных операций, связанных с моделями YOLO , таких как обучение, валидация, предсказание, экспорт и бенчмаркинг. Он работает с различными типами моделей, включая те, которые загруженные из локальных файлов, Ultralytics HUB или Triton Server. Класс разработан так, чтобы быть гибким и расширяемым для различных задач и конфигураций моделей.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
model |
Union[str, Path]
|
Путь или имя модели, которую нужно загрузить или создать. Это может быть локальный файл путь, имя модели из Ultralytics HUB или модель сервера Triton . По умолчанию - 'yolov8n.pt'. |
'yolov8n.pt'
|
task |
Any
|
Тип задачи, связанный с моделью YOLO . С его помощью можно указать область применения модели. область применения, например, обнаружение объектов, сегментация и так далее. По умолчанию - None. |
None
|
verbose |
bool
|
Если значение True, то включается подробный вывод информации во время работы модели. По умолчанию установлено значение False. |
False
|
Атрибуты:
Имя | Тип | Описание |
---|---|---|
callbacks |
dict
|
Словарь функций обратного вызова для различных событий во время работы модели. |
predictor |
BasePredictor
|
Объект-предсказатель, используемый для составления прогнозов. |
model |
Module
|
В основе лежит модель PyTorch . |
trainer |
BaseTrainer
|
Объект тренера, используемый для тренировки модели. |
ckpt |
dict
|
Данные контрольной точки, если модель загружается из файла *.pt. |
cfg |
str
|
Конфигурация модели, если она загружена из файла *.yaml. |
ckpt_path |
str
|
Путь к файлу контрольной точки. |
overrides |
dict
|
Словарь переопределений для конфигурации модели. |
metrics |
dict
|
Последние метрики тренировки/оценки. |
session |
HUBTrainingSession
|
Сессия Ultralytics HUB, если применимо. |
task |
str
|
Тип задания, для которого предназначена модель. |
model_name |
str
|
Название модели. |
Методы:
Имя | Описание |
---|---|
__call__ |
Псевдоним для метода predict, позволяющий вызывать экземпляр модели. |
_new |
Инициализирует новую модель на основе файла конфигурации. |
_load |
Загрузи модель из файла контрольных точек. |
_check_is_pytorch_model |
Убедись, что модель - это модель PyTorch . |
reset_weights |
Сбрось весовые коэффициенты модели к их начальному состоянию. |
load |
Загружает веса моделей из указанного файла. |
save |
Сохрани текущее состояние модели в файл. |
info |
Записывает в журнал или возвращает информацию о модели. |
fuse |
Объединяет слои Conv2d и BatchNorm2d для оптимизированного вывода. |
predict |
Выполняет прогнозирование обнаружения объектов. |
track |
Выполняет слежение за объектами. |
val |
Проверяет модель на наборе данных. |
benchmark |
Бенчмаркинг модели на различных форматах экспорта. |
export |
Экспортируй модель в различные форматы. |
train |
Обучает модель на наборе данных. |
tune |
Выполняет настройку гиперпараметров. |
_apply |
Примени функцию к тензорам модели. |
add_callback |
Добавляет функцию обратного вызова для события. |
clear_callback |
Очищает все обратные вызовы для события. |
reset_callbacks |
Сбрось все обратные вызовы к их функциям по умолчанию. |
_get_hub_session |
Извлекает или создает сессию Ultralytics HUB. |
is_triton_model |
Проверяет, является ли модель моделью Triton Server. |
is_hub_model |
Проверяет, является ли модель моделью Ultralytics HUB. |
_reset_ckpt_args |
Сбрось аргументы контрольной точки при загрузке модели PyTorch . |
_smart_load |
Загружает соответствующий модуль, исходя из задачи модели. |
task_map |
Обеспечивает отображение задач модели на соответствующие классы. |
Поднимает:
Тип | Описание |
---|---|
FileNotFoundError
|
Если указанный файл модели не существует или недоступен. |
ValueError
|
Если файл модели или конфигурация недействительны или не поддерживаются. |
ImportError
|
Если не установлены необходимые зависимости для конкретных типов моделей (например, HUB SDK). |
TypeError
|
Если модель не является моделью PyTorch , когда это необходимо. |
AttributeError
|
Если требуемые атрибуты или методы не реализованы или недоступны. |
NotImplementedError
|
Если конкретная модель задачи или режима не поддерживается. |
Исходный код в ultralytics/engine/model.py
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 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 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 |
|
device: torch.device
property
Извлекает устройство, на котором распределены параметры модели.
Это свойство используется для определения того, на каком процессоре или GPU работают параметры модели. Оно применяется только к моделям которые являются экземплярами nn.Module.
Возвращается:
Тип | Описание |
---|---|
device | None
|
Устройство (CPU/GPU) модели, если это модель PyTorch , в противном случае - Нет. |
names: list
property
Извлекает имена классов, связанных с загруженной моделью.
Это свойство возвращает имена классов, если они определены в модели. Оно проверяет имена классов на достоверность с помощью функции 'check_class_names' из модуля ultralytics.nn.autobackend.
Возвращается:
Тип | Описание |
---|---|
list | None
|
Имена классов модели, если они доступны, в противном случае - нет. |
task_map: dict
property
Сопоставьте голову с классами model, trainer, validator и predictor.
Возвращается:
Имя | Тип | Описание |
---|---|---|
task_map |
dict
|
Карта задания модели на классы режима. |
transforms
property
Извлекает преобразования, примененные к входным данным загруженной модели.
Это свойство возвращает трансформации, если они определены в модели.
Возвращается:
Тип | Описание |
---|---|
object | None
|
Объект трансформации модели, если он доступен, в противном случае - нет. |
__call__(source=None, stream=False, **kwargs)
Псевдоним для метода predict, позволяющий вызывать экземпляр модели.
Этот метод упрощает процесс прогнозирования, позволяя напрямую вызывать экземпляр модели с необходимыми аргументами для предсказания.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
source |
str | Path | int | Image | ndarray
|
Источник изображения для составления предсказания. Принимает различные типы, включая пути к файлам, URL, изображения PIL и массивы numpy. По умолчанию - None. |
None
|
stream |
bool
|
Если True, то для предсказаний входной источник будет рассматриваться как непрерывный поток. По умолчанию установлено значение False. |
False
|
**kwargs |
any
|
Дополнительные аргументы в виде ключевых слов для настройки процесса предсказания. |
{}
|
Возвращается:
Тип | Описание |
---|---|
List[Results]
|
Список результатов предсказаний, заключенный в класс Results. |
Исходный код в ultralytics/engine/model.py
__init__(model='yolov8n.pt', task=None, verbose=False)
Инициализирует новый экземпляр класса модели YOLO .
Этот конструктор устанавливает модель на основе предоставленного пути или имени модели. Он работает с различными типами источников модели источники, включая локальные файлы, модели Ultralytics HUB и Triton Server. Метод инициализирует несколько важных атрибутов модели и подготавливает ее к таким операциям, как обучение, предсказание или экспорт.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
model |
Union[str, Path]
|
Путь или файл модели, который нужно загрузить или создать. Это может быть локальный путь к файлу, имя модели из Ultralytics HUB или модель сервера Triton . По умолчанию - 'yolov8n.pt'. |
'yolov8n.pt'
|
task |
Any
|
Тип задачи, связанный с моделью YOLO и определяющий область ее применения. По умолчанию - None. |
None
|
verbose |
bool
|
Если значение True, то включается вывод подробной информации во время инициализации модели и последующих операций. операций. По умолчанию установлено значение False. |
False
|
Поднимает:
Тип | Описание |
---|---|
FileNotFoundError
|
Если указанный файл модели не существует или недоступен. |
ValueError
|
Если файл модели или конфигурация недействительны или не поддерживаются. |
ImportError
|
Если не установлены необходимые зависимости для конкретных типов моделей (например, HUB SDK). |
Исходный код в ultralytics/engine/model.py
add_callback(event, func)
Добавляет функцию обратного вызова для указанного события.
Этот метод позволяет пользователю зарегистрировать пользовательскую функцию обратного вызова, которая будет срабатывать по определенному событию во время обучения или вывода модели.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
event |
str
|
Имя события, к которому нужно прикрепить обратный вызов. |
требуется |
func |
callable
|
Функция обратного вызова, которую нужно зарегистрировать. |
требуется |
Поднимает:
Тип | Описание |
---|---|
ValueError
|
Если название события не распознано. |
Исходный код в ultralytics/engine/model.py
benchmark(**kwargs)
Бенчмаркинг модели в различных форматах экспорта для оценки производительности.
Этот метод оценивает производительность модели в различных форматах экспорта, таких как ONNX, TorchScript, и т. д. Он использует функцию 'benchmark' из модуля ultralytics.utils.benchmarks. Бенчмаркинг настраивается с помощью комбинации значений конфигурации по умолчанию, аргументов, относящихся к конкретной модели, умолчаний, относящихся к конкретному методу, и любых дополнительных аргументов, задаваемых пользователем.
Метод поддерживает различные аргументы, которые позволяют настраивать процесс бенчмаркинга, например, выбор набора данных выбор, размер изображения, режимы точности, выбор устройства и словесность. Для получения полного списка всех настраиваемых параметров, пользователям следует обратиться к разделу "Конфигурация" в документации.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
**kwargs |
any
|
Произвольные аргументы ключевых слов для настройки процесса бенчмаркинга. Они сочетаются с конфигурациями по умолчанию, аргументами, относящимися к конкретной модели, и параметрами метода по умолчанию. |
{}
|
Возвращается:
Тип | Описание |
---|---|
dict
|
Словарь, содержащий результаты бенчмаркинга. |
Поднимает:
Тип | Описание |
---|---|
AssertionError
|
Если модель не является моделью PyTorch . |
Исходный код в ultralytics/engine/model.py
clear_callback(event)
Очищает все функции обратного вызова, зарегистрированные для указанного события.
Этот метод удаляет все пользовательские и стандартные функции обратного вызова, связанные с данным событием.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
event |
str
|
Имя события, для которого нужно очистить обратные вызовы. |
требуется |
Поднимает:
Тип | Описание |
---|---|
ValueError
|
Если название события не распознано. |
Исходный код в ultralytics/engine/model.py
embed(source=None, stream=False, **kwargs)
Генерирует вкрапления изображений на основе предоставленного источника.
Этот метод представляет собой обертку вокруг метода 'predict()', ориентированную на генерацию вкраплений из источника изображения. Он позволяет настраивать процесс встраивания с помощью различных аргументов в виде ключевых слов.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
source |
str | int | Image | ndarray
|
Источник изображения для генерации вкраплений. Источником может быть путь к файлу, URL, PIL-изображение, массив numpy и так далее. По умолчанию - None. |
None
|
stream |
bool
|
Если True, то предсказания будут транслироваться. По умолчанию установлено значение False. |
False
|
**kwargs |
any
|
Дополнительные аргументы в виде ключевых слов для настройки процесса встраивания. |
{}
|
Возвращается:
Тип | Описание |
---|---|
List[Tensor]
|
Список, содержащий вкрапления изображений. |
Поднимает:
Тип | Описание |
---|---|
AssertionError
|
Если модель не является моделью PyTorch . |
Исходный код в ultralytics/engine/model.py
export(**kwargs)
Экспортирует модель в другой формат, подходящий для развертывания.
Этот метод облегчает экспорт модели в различные форматы (например, ONNX, TorchScript) для развертывания. для целей развертывания. Он использует класс 'Exporter' для процесса экспорта, комбинируя специфические для модели переопределения, метод по умолчанию и любые дополнительные аргументы. Объединенные аргументы используются для настройки параметров экспорта.
Метод поддерживает широкий спектр аргументов для настройки процесса экспорта. Полный список всех возможных аргументов, обратись к разделу "Конфигурация" в документации.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
**kwargs |
any
|
Произвольные аргументы ключевых слов для настройки процесса экспорта. Они комбинируются с переопределениями модели и настройками методов по умолчанию. |
{}
|
Возвращается:
Тип | Описание |
---|---|
str
|
Имя файла экспортированной модели в указанном формате или объект, связанный с процессом экспорта. |
Поднимает:
Тип | Описание |
---|---|
AssertionError
|
Если модель не является моделью PyTorch . |
Исходный код в ultralytics/engine/model.py
fuse()
Объедини в модели слои Conv2d и BatchNorm2d.
Этот метод оптимизирует модель, объединяя слои Conv2d и BatchNorm2d, что позволяет повысить скорость вычислений.
Поднимает:
Тип | Описание |
---|---|
AssertionError
|
Если модель не является моделью PyTorch . |
Исходный код в ultralytics/engine/model.py
info(detailed=False, verbose=True)
Записывает в журнал или возвращает информацию о модели.
Этот метод предоставляет обзорную или подробную информацию о модели, в зависимости от переданных аргументов. Он может контролировать многословность вывода.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
detailed |
bool
|
Если True, то показывает подробную информацию о модели. По умолчанию установлено значение False. |
False
|
verbose |
bool
|
Если True, то выводит информацию. Если False, то возвращает информацию. По умолчанию установлено значение True. |
True
|
Возвращается:
Тип | Описание |
---|---|
list
|
Различные типы информации о модели, в зависимости от параметров 'detailed' и 'verbose'. |
Поднимает:
Тип | Описание |
---|---|
AssertionError
|
Если модель не является моделью PyTorch . |
Исходный код в ultralytics/engine/model.py
is_hub_model(model)
staticmethod
Проверь, является ли предоставленная модель моделью HUB.
Исходный код в ultralytics/engine/model.py
is_triton_model(model)
staticmethod
Модель представляет собой строку URL-адреса сервера Triton , т.е.
Исходный код в ultralytics/engine/model.py
load(weights='yolov8n.pt')
Загрузи в модель параметры из указанного файла весов.
Этот метод поддерживает загрузку весов из файла или непосредственно из объекта весов. Он сопоставляет параметры по имени и форме и передает их в модель.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
weights |
str | Path
|
Путь к файлу весов или объекту весов. По умолчанию 'yolov8n.pt'. |
'yolov8n.pt'
|
Возвращается:
Имя | Тип | Описание |
---|---|---|
self |
Model
|
Экземпляр класса с нагруженными весами. |
Поднимает:
Тип | Описание |
---|---|
AssertionError
|
Если модель не является моделью PyTorch . |
Исходный код в ultralytics/engine/model.py
predict(source=None, stream=False, predictor=None, **kwargs)
Выполни предсказания для заданного источника изображения, используя модель YOLO .
Этот метод облегчает процесс предсказания, позволяя выполнять различные конфигурации с помощью аргументов в виде ключевых слов. Он поддерживает предсказания с помощью пользовательских предикторов или метода предикторов по умолчанию. Метод работает с различными типами источников изображений и может работать в потоковом режиме. Он также обеспечивает поддержку моделей типа SAM. с помощью "подсказок".
Метод устанавливает новый предиктор, если его еще нет, и обновляет свои аргументы при каждом вызове. Он также выдает предупреждение и использует активы по умолчанию, если не указан 'source'. Метод определяет, вызывается ли он вызывается из интерфейса командной строки, и соответствующим образом настраивает свое поведение, включая установку значений по умолчанию для порога доверия и поведения при сохранении.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
source |
str | int | Image | ndarray
|
Источник изображения для составления прогнозов. Принимает различные типы, включая пути к файлам, URL, PIL-изображения и массивы numpy. По умолчанию - ASSETS. |
None
|
stream |
bool
|
Рассматривает входной источник как непрерывный поток для предсказаний. По умолчанию установлено значение False. |
False
|
predictor |
BasePredictor
|
Экземпляр пользовательского класса предиктора для составления прогнозов. Если None, метод использует предиктор по умолчанию. По умолчанию - None. |
None
|
**kwargs |
any
|
Дополнительные аргументы в виде ключевых слов для настройки процесса предсказания. Эти аргументы позволяют еще больше настроить поведение предсказания. |
{}
|
Возвращается:
Тип | Описание |
---|---|
List[Results]
|
Список результатов предсказаний, заключенный в класс Results. |
Поднимает:
Тип | Описание |
---|---|
AttributeError
|
Если предсказатель неправильно настроен. |
Исходный код в ultralytics/engine/model.py
reset_callbacks()
Сбрось все обратные вызовы к их функциям по умолчанию.
Этот метод восстанавливает стандартные функции обратного вызова для всех событий, удаляя все пользовательские обратные вызовы, которые были добавлены ранее. добавленные ранее.
Исходный код в ultralytics/engine/model.py
reset_weights()
Сбрось параметры модели к случайно инициализированным значениям, фактически отбросив всю обучающую информацию.
Этот метод перебирает все модули в модели и сбрасывает их параметры, если у них есть метод 'reset_parameters' метод. Он также гарантирует, что для всех параметров 'requires_grad' установлено значение True, что позволит им обновлять их во время обучения.
Возвращается:
Имя | Тип | Описание |
---|---|---|
self |
Model
|
Экземпляр класса со сброшенными весами. |
Поднимает:
Тип | Описание |
---|---|
AssertionError
|
Если модель не является моделью PyTorch . |
Исходный код в ultralytics/engine/model.py
save(filename='saved_model.pt', use_dill=True)
Сохрани текущее состояние модели в файл.
Этот метод экспортирует контрольную точку модели (ckpt) в указанный файл.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
filename |
str | Path
|
Имя файла, в который нужно сохранить модель. По умолчанию 'saved_model.pt'. |
'saved_model.pt'
|
use_dill |
bool
|
Нужно ли пытаться использовать dill для сериализации, если она доступна. По умолчанию установлено значение True. |
True
|
Поднимает:
Тип | Описание |
---|---|
AssertionError
|
Если модель не является моделью PyTorch . |
Исходный код в ultralytics/engine/model.py
track(source=None, stream=False, persist=False, **kwargs)
Проводит отслеживание объектов на указанном источнике входного сигнала с помощью зарегистрированных трекеров.
Этот метод выполняет слежение за объектом, используя предикторы модели и опционально зарегистрированные трекеры. Он способен работать с различными типами входных источников, такими как пути к файлам или видеопотоки. Метод поддерживает настраивать процесс отслеживания с помощью различных ключевых слов-аргументов. Он регистрирует трекеры, если они еще не и по желанию сохраняет их на основе флага 'persist'.
Метод устанавливает порог доверия по умолчанию специально для отслеживания на основе ByteTrack, которое требует низкого уверенности в прогнозах в качестве входных данных. Режим отслеживания задается явно в аргументах ключевых слов.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
source |
str
|
Источник входного сигнала для отслеживания объекта. Это может быть путь к файлу, URL или видеопоток. |
None
|
stream |
bool
|
Рассматривает источник входного сигнала как непрерывный видеопоток. По умолчанию установлено значение False. |
False
|
persist |
bool
|
Сохраняет трекеры между разными вызовами этого метода. По умолчанию принимает значение False. |
False
|
**kwargs |
any
|
Дополнительные аргументы в виде ключевых слов для настройки процесса отслеживания. Эти аргументы позволяют дальнейшую настройку поведения трекинга. |
{}
|
Возвращается:
Тип | Описание |
---|---|
List[Results]
|
Список результатов отслеживания, заключенный в класс Results. |
Поднимает:
Тип | Описание |
---|---|
AttributeError
|
Если у предсказателя нет зарегистрированных трекеров. |
Исходный код в ultralytics/engine/model.py
train(trainer=None, **kwargs)
Обучает модель, используя указанный набор данных и конфигурацию обучения.
Этот метод облегчает обучение модели с помощью ряда настраиваемых параметров и конфигураций. Он поддерживает обучение с помощью пользовательского тренера или подхода к обучению по умолчанию, определенного в методе. Метод обрабатывает различные сценарии, такие как возобновление обучения с контрольной точки, интеграция с Ultralytics HUB и обновление модели и конфигурации после тренировки.
При использовании Ultralytics HUB, если в сессии уже есть загруженная модель, метод отдает приоритет тренировочным аргументам HUB аргументы и выдает предупреждение, если указаны локальные аргументы. Он проверяет обновления pip и комбинирует конфигурации по умолчанию конфигурации, специфические для метода значения по умолчанию и аргументы, предоставленные пользователем, для настройки процесса обучения. После После обучения он обновляет модель и ее конфигурации, а также по желанию прикрепляет метрики.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
trainer |
BaseTrainer
|
Экземпляр пользовательского класса тренера для обучения модели. Если нет, то метод использует тренера по умолчанию. По умолчанию - None. |
None
|
**kwargs |
any
|
Произвольные аргументы в виде ключевых слов, представляющие конфигурацию тренировки. Эти аргументы используются для настройки различных аспектов тренировочного процесса. |
{}
|
Возвращается:
Тип | Описание |
---|---|
dict | None
|
Показатели тренировки, если они доступны и тренировка прошла успешно; в противном случае - нет. |
Поднимает:
Тип | Описание |
---|---|
AssertionError
|
Если модель не является моделью PyTorch . |
PermissionError
|
Если в сессии HUB возникли проблемы с разрешением. |
ModuleNotFoundError
|
Если HUB SDK не установлен. |
Исходный код в ultralytics/engine/model.py
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 |
|
tune(use_ray=False, iterations=10, *args, **kwargs)
Проводит настройку гиперпараметров для модели, с возможностью использования Ray Tune.
Этот метод поддерживает два режима настройки гиперпараметров: использование Ray Tune или собственный метод настройки. Когда функция Ray Tune включена, она использует функцию 'run_ray_tune' из модуля ultralytics.utils.tuner. В противном случае для настройки используется внутренний класс 'Tuner'. Метод сочетает в себе стандартные, переопределенные и пользовательские аргументы для настройки процесса тюнинга.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
use_ray |
bool
|
Если True, то для настройки гиперпараметров используется Ray Tune. По умолчанию установлено значение False. |
False
|
iterations |
int
|
Количество итераций настройки, которые нужно выполнить. По умолчанию - 10. |
10
|
*args |
list
|
Список аргументов переменной длины для дополнительных аргументов. |
()
|
**kwargs |
any
|
Произвольные аргументы ключевых слов. Они комбинируются с переопределениями модели и настройками по умолчанию. |
{}
|
Возвращается:
Тип | Описание |
---|---|
dict
|
Словарь, содержащий результаты поиска гиперпараметров. |
Поднимает:
Тип | Описание |
---|---|
AssertionError
|
Если модель не является моделью PyTorch . |
Исходный код в ultralytics/engine/model.py
val(validator=None, **kwargs)
Проверяет модель, используя указанный набор данных и конфигурацию проверки.
Этот метод облегчает процесс проверки модели, позволяя настраивать ее с помощью различных настройки и конфигурации. Он поддерживает валидацию с помощью пользовательского валидатора или валидацию по умолчанию. Метод сочетает в себе конфигурации по умолчанию, специфические для метода настройки по умолчанию и аргументы, предоставляемые пользователем, для настройки процесс валидации. После валидации он обновляет метрики модели с учетом результатов, полученных от валидатора.
Метод поддерживает различные аргументы, которые позволяют настраивать процесс проверки. Для получения полного список всех настраиваемых параметров, пользователям следует обратиться к разделу "Конфигурация" в документации.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
validator |
BaseValidator
|
Экземпляр пользовательского класса валидатора для проверки модели. Если None, метод использует валидатор по умолчанию. По умолчанию используется None. |
None
|
**kwargs |
any
|
Произвольные аргументы в виде ключевых слов, представляющие конфигурацию проверки. Эти аргументы используются для настройки различных аспектов процесса проверки. |
{}
|
Возвращается:
Тип | Описание |
---|---|
dict
|
Валидационные метрики, полученные в процессе проверки. |
Поднимает:
Тип | Описание |
---|---|
AssertionError
|
Если модель не является моделью PyTorch . |