参考 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 モデルに関連するさまざまな操作のための共通インターフェイスを提供します、 検証、予測、エクスポート、ベンチマークなどです。このクラスは、ローカルファイル、 HUB、 Server からロードされたモデルを含む、さまざまなタイプのモデルを扱います。 ローカルファイル、Ultralytics HUB、またはTriton Serverからロードされたものを含む。このクラスは柔軟で このクラスは、さまざまなタスクやモデル構成に対して柔軟に拡張できるように設計されています。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
model |
Union[str, Path]
|
ロードまたは作成するモデルのパスまたは名前。これはローカルファイル パス、Ultralytics HUB からのモデル名、またはTriton Server モデルです。デフォルトは '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
モデルのパラメータが割り当てられているデバイスを取得します。
このプロパティは、モデルのパラメータがCPU上かGPU上かを判断するために使用されます。このプロパティは のインスタンスにのみ適用されます。
リターンズ
タイプ | 説明 |
---|---|
device | None
|
PyTorch モデルであればそのモデルのデバイス(CPU/GPU)、そうでなければ None。 |
names: list
property
ロードされたモデルに関連付けられたクラス名を取得します。
このプロパティは、クラス名がモデル内で定義されている場合に、そのクラス名を返します。このプロパティは ultralytics.nn.autobackend モジュールの 'check_class_names' 関数を使用しています。
リターンズ
タイプ | 説明 |
---|---|
list | None
|
利用可能であればモデルのクラス名、そうでなければ None。 |
task_map: dict
property
ヘッドをモデル、トレーナー、バリデータ、およびプレディクタ・クラスにマップします。
リターンズ
名称 | タイプ | 説明 |
---|---|---|
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 Server モデルです。デフォルトは '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 などの異なるエクスポート形式におけるモデルのパフォーマンスを評価します。 ultralytics.utils.benchmarksモジュールの'benchmark'関数を使用します。ベンチマークは ベンチマークは、デフォルトの設定値、モデル固有の引数、メソッド固有のデフォルト、そしてユーザが提供するキーワード引数を組み合わせて設定されます。 ユーザー提供のキーワード引数を追加します。
このメソッドは、ベンチマークプロセスのカスタマイズを可能にする様々な引数をサポートしています。 の選択、画像サイズ、精度モード、デバイスの選択、冗長性などです。設定可能な 設定可能なオプションの包括的なリストについては、ドキュメントの 'configuration' セクションを参照してください。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
**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
モデルは、Triton サーバーの URL 文字列です。
ソースコード 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'メソッドを持っていればパラメータをリセットします。 '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 トレーニング引数を優先します。 引数を優先し、ローカル引数が指定されている場合は警告を発します。パイプの更新をチェックし、デフォルトの 設定、メソッド固有のデフォルト、ユーザが提供した引数を組み合わせてトレーニングプロセスを設定します。トレーニング後 トレーニング後、モデルとその設定を更新し、オプションでメトリクスをアタッチします。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
trainer |
BaseTrainer
|
モデルをトレーニングするためのカスタムトレーナークラスのインスタンス。None の場合 メソッドはデフォルトのトレーナを使用します。デフォルトは 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)
モデルのハイパーパラメータチューニングを行います。オプションでレイチューンを使用できます。
このメソッドは、ハイパーパラメータチューニングの2つのモードをサポートします:Ray Tuneを使用するか、カスタムチューニングメソッドを使用するかです。 Ray Tuneが有効な場合、ultralytics.utils.tunerモジュールの'run_ray_tune'関数を利用します。 そうでない場合は、内部の'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 モデルでない場合。 |