Bỏ để qua phần nội dung

Tài liệu tham khảo cho ultralytics/engine/model.py

Ghi

Tệp này có sẵn tại https://github.com/ultralytics/ultralytics/blob/main/ultralytics/động cơ/model.py. Nếu bạn phát hiện ra một vấn đề, vui lòng giúp khắc phục nó bằng cách đóng góp Yêu cầu 🛠️ kéo. Cảm ơn bạn 🙏 !



ultralytics.engine.model.Model

Căn cứ: Module

Một lớp cơ sở để thực hiện YOLO mô hình, thống nhất API trên các loại mô hình khác nhau.

Lớp này cung cấp một giao diện chung cho các hoạt động khác nhau liên quan đến YOLO mô hình, chẳng hạn như đào tạo, xác nhận, dự đoán, xuất và đo điểm chuẩn. Nó xử lý các loại mô hình khác nhau, bao gồm cả những mô hình được tải từ các tệp cục bộ, Ultralytics HUB, hoặc Triton Máy chủ. Lớp học được thiết kế linh hoạt và Có thể mở rộng cho các tác vụ và cấu hình mô hình khác nhau.

Thông số:

Tên Kiểu Sự miêu tả Mặc định
model Union[str, Path]

Đường dẫn hoặc tên của mô hình để tải hoặc tạo. Đây có thể là một tệp cục bộ đường dẫn, tên mô hình từ Ultralytics HUB hoặc một Triton Mô hình máy chủ. Mặc định là 'yolov8n.pt'.

'yolov8n.pt'
task Any

Loại tác vụ được liên kết với YOLO mẫu. Điều này có thể được sử dụng để chỉ định mô hình miền ứng dụng, chẳng hạn như phát hiện đối tượng, phân đoạn, v.v. Mặc định là Không có.

None
verbose bool

Nếu True, cho phép đầu ra chi tiết trong quá trình hoạt động của mô hình. Mặc định là False.

False

Thuộc tính:

Tên Kiểu Sự miêu tả
callbacks dict

Một từ điển các hàm callback cho các sự kiện khác nhau trong các hoạt động mô hình.

predictor BasePredictor

Đối tượng dự đoán được sử dụng để đưa ra dự đoán.

model Module

Cơ bản PyTorch mẫu.

trainer BaseTrainer

Đối tượng huấn luyện được sử dụng để đào tạo mô hình.

ckpt dict

Dữ liệu điểm kiểm tra nếu mô hình được tải từ tệp * .pt.

cfg str

Cấu hình của mô hình nếu được tải từ tệp * .yaml.

ckpt_path str

Đường dẫn đến tệp điểm kiểm tra.

overrides dict

Từ điển ghi đè cho cấu hình mô hình.

metrics dict

Các chỉ số đào tạo/xác nhận mới nhất.

session HUBTrainingSession

Các Ultralytics Phiên HUB, nếu có.

task str

Loại nhiệm vụ mà mô hình được dành cho.

model_name str

Tên của mô hình.

Phương pháp:

Tên Sự miêu tả
__call__

Bí danh cho phương thức predict, cho phép đối tượng mô hình có thể gọi được.

_new

Khởi tạo mô hình mới dựa trên tệp cấu hình.

_load

Tải mô hình từ tệp điểm kiểm tra.

_check_is_pytorch_model

Đảm bảo rằng mô hình là một PyTorch mẫu.

reset_weights

Đặt lại trọng lượng của mô hình về trạng thái ban đầu.

load

Tải trọng số mô hình từ một tệp được chỉ định.

save

Lưu trạng thái hiện tại của mô hình vào một tệp.

info

Ghi nhật ký hoặc trả về thông tin về mô hình.

fuse

Hợp nhất các lớp Conv2d và BatchNorm2d để tối ưu hóa suy luận.

predict

Thực hiện dự đoán phát hiện đối tượng.

track

Thực hiện theo dõi đối tượng.

val

Xác thực mô hình trên tập dữ liệu.

benchmark

Điểm chuẩn mô hình trên các định dạng xuất khác nhau.

export

Xuất mô hình sang các định dạng khác nhau.

train

Đào tạo mô hình trên một tập dữ liệu.

tune

Thực hiện điều chỉnh siêu tham số.

_apply

Áp dụng một chức năng cho tensor của mô hình.

add_callback

Thêm hàm gọi lại cho một sự kiện.

clear_callback

Xóa tất cả các cuộc gọi lại cho một sự kiện.

reset_callbacks

Đặt lại tất cả các callback về chức năng mặc định của chúng.

_get_hub_session

Truy xuất hoặc tạo một Ultralytics Phiên HUB.

is_triton_model

Kiểm tra xem mô hình có phải là mô hình hay không Triton Mô hình máy chủ.

is_hub_model

Kiểm tra xem mô hình có phải là mô hình hay không Ultralytics Mô hình HUB.

_reset_ckpt_args

Đặt lại đối số điểm kiểm tra khi tải PyTorch mẫu.

_smart_load

Tải mô-đun thích hợp dựa trên tác vụ mô hình.

task_map

Cung cấp ánh xạ từ các nhiệm vụ mô hình đến các lớp tương ứng.

Tăng:

Kiểu Sự miêu tả
FileNotFoundError

Nếu tệp mô hình được chỉ định không tồn tại hoặc không thể truy cập được.

ValueError

Nếu tệp mô hình hoặc cấu hình không hợp lệ hoặc không được hỗ trợ.

ImportError

Nếu được yêu cầu, các phần phụ thuộc cho các loại mô hình cụ thể (như HUB SDK) sẽ không được cài đặt.

TypeError

Nếu mô hình không phải là một PyTorch mô hình khi có yêu cầu.

AttributeError

Nếu các thuộc tính hoặc phương pháp bắt buộc không được triển khai hoặc có sẵn.

NotImplementedError

Nếu một tác vụ hoặc chế độ mô hình cụ thể không được hỗ trợ.

Mã nguồn trong 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
class Model(nn.Module):
    """
    A base class for implementing YOLO models, unifying APIs across different model types.

    This class provides a common interface for various operations related to YOLO models, such as training,
    validation, prediction, exporting, and benchmarking. It handles different types of models, including those
    loaded from local files, Ultralytics HUB, or Triton Server. The class is designed to be flexible and
    extendable for different tasks and model configurations.

    Args:
        model (Union[str, Path], optional): Path or name of the model to load or create. This can be a local file
            path, a model name from Ultralytics HUB, or a Triton Server model. Defaults to 'yolov8n.pt'.
        task (Any, optional): The task type associated with the YOLO model. This can be used to specify the model's
            application domain, such as object detection, segmentation, etc. Defaults to None.
        verbose (bool, optional): If True, enables verbose output during the model's operations. Defaults to False.

    Attributes:
        callbacks (dict): A dictionary of callback functions for various events during model operations.
        predictor (BasePredictor): The predictor object used for making predictions.
        model (nn.Module): The underlying PyTorch model.
        trainer (BaseTrainer): The trainer object used for training the model.
        ckpt (dict): The checkpoint data if the model is loaded from a *.pt file.
        cfg (str): The configuration of the model if loaded from a *.yaml file.
        ckpt_path (str): The path to the checkpoint file.
        overrides (dict): A dictionary of overrides for model configuration.
        metrics (dict): The latest training/validation metrics.
        session (HUBTrainingSession): The Ultralytics HUB session, if applicable.
        task (str): The type of task the model is intended for.
        model_name (str): The name of the model.

    Methods:
        __call__: Alias for the predict method, enabling the model instance to be callable.
        _new: Initializes a new model based on a configuration file.
        _load: Loads a model from a checkpoint file.
        _check_is_pytorch_model: Ensures that the model is a PyTorch model.
        reset_weights: Resets the model's weights to their initial state.
        load: Loads model weights from a specified file.
        save: Saves the current state of the model to a file.
        info: Logs or returns information about the model.
        fuse: Fuses Conv2d and BatchNorm2d layers for optimized inference.
        predict: Performs object detection predictions.
        track: Performs object tracking.
        val: Validates the model on a dataset.
        benchmark: Benchmarks the model on various export formats.
        export: Exports the model to different formats.
        train: Trains the model on a dataset.
        tune: Performs hyperparameter tuning.
        _apply: Applies a function to the model's tensors.
        add_callback: Adds a callback function for an event.
        clear_callback: Clears all callbacks for an event.
        reset_callbacks: Resets all callbacks to their default functions.
        _get_hub_session: Retrieves or creates an Ultralytics HUB session.
        is_triton_model: Checks if a model is a Triton Server model.
        is_hub_model: Checks if a model is an Ultralytics HUB model.
        _reset_ckpt_args: Resets checkpoint arguments when loading a PyTorch model.
        _smart_load: Loads the appropriate module based on the model task.
        task_map: Provides a mapping from model tasks to corresponding classes.

    Raises:
        FileNotFoundError: If the specified model file does not exist or is inaccessible.
        ValueError: If the model file or configuration is invalid or unsupported.
        ImportError: If required dependencies for specific model types (like HUB SDK) are not installed.
        TypeError: If the model is not a PyTorch model when required.
        AttributeError: If required attributes or methods are not implemented or available.
        NotImplementedError: If a specific model task or mode is not supported.
    """

    def __init__(
        self,
        model: Union[str, Path] = "yolov8n.pt",
        task: str = None,
        verbose: bool = False,
    ) -> None:
        """
        Initializes a new instance of the YOLO model class.

        This constructor sets up the model based on the provided model path or name. It handles various types of model
        sources, including local files, Ultralytics HUB models, and Triton Server models. The method initializes several
        important attributes of the model and prepares it for operations like training, prediction, or export.

        Args:
            model (Union[str, Path], optional): The path or model file to load or create. This can be a local
                file path, a model name from Ultralytics HUB, or a Triton Server model. Defaults to 'yolov8n.pt'.
            task (Any, optional): The task type associated with the YOLO model, specifying its application domain.
                Defaults to None.
            verbose (bool, optional): If True, enables verbose output during the model's initialization and subsequent
                operations. Defaults to False.

        Raises:
            FileNotFoundError: If the specified model file does not exist or is inaccessible.
            ValueError: If the model file or configuration is invalid or unsupported.
            ImportError: If required dependencies for specific model types (like HUB SDK) are not installed.
        """
        super().__init__()
        self.callbacks = callbacks.get_default_callbacks()
        self.predictor = None  # reuse predictor
        self.model = None  # model object
        self.trainer = None  # trainer object
        self.ckpt = None  # if loaded from *.pt
        self.cfg = None  # if loaded from *.yaml
        self.ckpt_path = None
        self.overrides = {}  # overrides for trainer object
        self.metrics = None  # validation/training metrics
        self.session = None  # HUB session
        self.task = task  # task type
        model = str(model).strip()

        # Check if Ultralytics HUB model from https://hub.ultralytics.com
        if self.is_hub_model(model):
            # Fetch model from HUB
            checks.check_requirements("hub-sdk>=0.0.6")
            self.session = self._get_hub_session(model)
            model = self.session.model_file

        # Check if Triton Server model
        elif self.is_triton_model(model):
            self.model_name = self.model = model
            self.task = task
            return

        # Load or create new YOLO model
        if Path(model).suffix in {".yaml", ".yml"}:
            self._new(model, task=task, verbose=verbose)
        else:
            self._load(model, task=task)

    def __call__(
        self,
        source: Union[str, Path, int, list, tuple, np.ndarray, torch.Tensor] = None,
        stream: bool = False,
        **kwargs,
    ) -> list:
        """
        An alias for the predict method, enabling the model instance to be callable.

        This method simplifies the process of making predictions by allowing the model instance to be called directly
        with the required arguments for prediction.

        Args:
            source (str | Path | int | PIL.Image | np.ndarray, optional): The source of the image for making
                predictions. Accepts various types, including file paths, URLs, PIL images, and numpy arrays.
                Defaults to None.
            stream (bool, optional): If True, treats the input source as a continuous stream for predictions.
                Defaults to False.
            **kwargs (any): Additional keyword arguments for configuring the prediction process.

        Returns:
            (List[ultralytics.engine.results.Results]): A list of prediction results, encapsulated in the Results class.
        """
        return self.predict(source, stream, **kwargs)

    @staticmethod
    def _get_hub_session(model: str):
        """Creates a session for Hub Training."""
        from ultralytics.hub.session import HUBTrainingSession

        session = HUBTrainingSession(model)
        return session if session.client.authenticated else None

    @staticmethod
    def is_triton_model(model: str) -> bool:
        """Is model a Triton Server URL string, i.e. <scheme>://<netloc>/<endpoint>/<task_name>"""
        from urllib.parse import urlsplit

        url = urlsplit(model)
        return url.netloc and url.path and url.scheme in {"http", "grpc"}

    @staticmethod
    def is_hub_model(model: str) -> bool:
        """Check if the provided model is a HUB model."""
        return any(
            (
                model.startswith(f"{HUB_WEB_ROOT}/models/"),  # i.e. https://hub.ultralytics.com/models/MODEL_ID
                [len(x) for x in model.split("_")] == [42, 20],  # APIKEY_MODEL
                len(model) == 20 and not Path(model).exists() and all(x not in model for x in "./\\"),  # MODEL
            )
        )

    def _new(self, cfg: str, task=None, model=None, verbose=False) -> None:
        """
        Initializes a new model and infers the task type from the model definitions.

        Args:
            cfg (str): model configuration file
            task (str | None): model task
            model (BaseModel): Customized model.
            verbose (bool): display model info on load
        """
        cfg_dict = yaml_model_load(cfg)
        self.cfg = cfg
        self.task = task or guess_model_task(cfg_dict)
        self.model = (model or self._smart_load("model"))(cfg_dict, verbose=verbose and RANK == -1)  # build model
        self.overrides["model"] = self.cfg
        self.overrides["task"] = self.task

        # Below added to allow export from YAMLs
        self.model.args = {**DEFAULT_CFG_DICT, **self.overrides}  # combine default and model args (prefer model args)
        self.model.task = self.task
        self.model_name = cfg

    def _load(self, weights: str, task=None) -> None:
        """
        Initializes a new model and infers the task type from the model head.

        Args:
            weights (str): model checkpoint to be loaded
            task (str | None): model task
        """
        if weights.lower().startswith(("https://", "http://", "rtsp://", "rtmp://", "tcp://")):
            weights = checks.check_file(weights)  # automatically download and return local filename
        weights = checks.check_model_file_from_stem(weights)  # add suffix, i.e. yolov8n -> yolov8n.pt

        if Path(weights).suffix == ".pt":
            self.model, self.ckpt = attempt_load_one_weight(weights)
            self.task = self.model.args["task"]
            self.overrides = self.model.args = self._reset_ckpt_args(self.model.args)
            self.ckpt_path = self.model.pt_path
        else:
            weights = checks.check_file(weights)  # runs in all cases, not redundant with above call
            self.model, self.ckpt = weights, None
            self.task = task or guess_model_task(weights)
            self.ckpt_path = weights
        self.overrides["model"] = weights
        self.overrides["task"] = self.task
        self.model_name = weights

    def _check_is_pytorch_model(self) -> None:
        """Raises TypeError is model is not a PyTorch model."""
        pt_str = isinstance(self.model, (str, Path)) and Path(self.model).suffix == ".pt"
        pt_module = isinstance(self.model, nn.Module)
        if not (pt_module or pt_str):
            raise TypeError(
                f"model='{self.model}' should be a *.pt PyTorch model to run this method, but is a different format. "
                f"PyTorch models can train, val, predict and export, i.e. 'model.train(data=...)', but exported "
                f"formats like ONNX, TensorRT etc. only support 'predict' and 'val' modes, "
                f"i.e. 'yolo predict model=yolov8n.onnx'.\nTo run CUDA or MPS inference please pass the device "
                f"argument directly in your inference command, i.e. 'model.predict(source=..., device=0)'"
            )

    def reset_weights(self) -> "Model":
        """
        Resets the model parameters to randomly initialized values, effectively discarding all training information.

        This method iterates through all modules in the model and resets their parameters if they have a
        'reset_parameters' method. It also ensures that all parameters have 'requires_grad' set to True, enabling them
        to be updated during training.

        Returns:
            self (ultralytics.engine.model.Model): The instance of the class with reset weights.

        Raises:
            AssertionError: If the model is not a PyTorch model.
        """
        self._check_is_pytorch_model()
        for m in self.model.modules():
            if hasattr(m, "reset_parameters"):
                m.reset_parameters()
        for p in self.model.parameters():
            p.requires_grad = True
        return self

    def load(self, weights: Union[str, Path] = "yolov8n.pt") -> "Model":
        """
        Loads parameters from the specified weights file into the model.

        This method supports loading weights from a file or directly from a weights object. It matches parameters by
        name and shape and transfers them to the model.

        Args:
            weights (str | Path): Path to the weights file or a weights object. Defaults to 'yolov8n.pt'.

        Returns:
            self (ultralytics.engine.model.Model): The instance of the class with loaded weights.

        Raises:
            AssertionError: If the model is not a PyTorch model.
        """
        self._check_is_pytorch_model()
        if isinstance(weights, (str, Path)):
            weights, self.ckpt = attempt_load_one_weight(weights)
        self.model.load(weights)
        return self

    def save(self, filename: Union[str, Path] = "saved_model.pt", use_dill=True) -> None:
        """
        Saves the current model state to a file.

        This method exports the model's checkpoint (ckpt) to the specified filename.

        Args:
            filename (str | Path): The name of the file to save the model to. Defaults to 'saved_model.pt'.
            use_dill (bool): Whether to try using dill for serialization if available. Defaults to True.

        Raises:
            AssertionError: If the model is not a PyTorch model.
        """
        self._check_is_pytorch_model()
        from datetime import datetime

        from ultralytics import __version__

        updates = {
            "date": datetime.now().isoformat(),
            "version": __version__,
            "license": "AGPL-3.0 License (https://ultralytics.com/license)",
            "docs": "https://docs.ultralytics.com",
        }
        torch.save({**self.ckpt, **updates}, filename, use_dill=use_dill)

    def info(self, detailed: bool = False, verbose: bool = True):
        """
        Logs or returns model information.

        This method provides an overview or detailed information about the model, depending on the arguments passed.
        It can control the verbosity of the output.

        Args:
            detailed (bool): If True, shows detailed information about the model. Defaults to False.
            verbose (bool): If True, prints the information. If False, returns the information. Defaults to True.

        Returns:
            (list): Various types of information about the model, depending on the 'detailed' and 'verbose' parameters.

        Raises:
            AssertionError: If the model is not a PyTorch model.
        """
        self._check_is_pytorch_model()
        return self.model.info(detailed=detailed, verbose=verbose)

    def fuse(self):
        """
        Fuses Conv2d and BatchNorm2d layers in the model.

        This method optimizes the model by fusing Conv2d and BatchNorm2d layers, which can improve inference speed.

        Raises:
            AssertionError: If the model is not a PyTorch model.
        """
        self._check_is_pytorch_model()
        self.model.fuse()

    def embed(
        self,
        source: Union[str, Path, int, list, tuple, np.ndarray, torch.Tensor] = None,
        stream: bool = False,
        **kwargs,
    ) -> list:
        """
        Generates image embeddings based on the provided source.

        This method is a wrapper around the 'predict()' method, focusing on generating embeddings from an image source.
        It allows customization of the embedding process through various keyword arguments.

        Args:
            source (str | int | PIL.Image | np.ndarray): The source of the image for generating embeddings.
                The source can be a file path, URL, PIL image, numpy array, etc. Defaults to None.
            stream (bool): If True, predictions are streamed. Defaults to False.
            **kwargs (any): Additional keyword arguments for configuring the embedding process.

        Returns:
            (List[torch.Tensor]): A list containing the image embeddings.

        Raises:
            AssertionError: If the model is not a PyTorch model.
        """
        if not kwargs.get("embed"):
            kwargs["embed"] = [len(self.model.model) - 2]  # embed second-to-last layer if no indices passed
        return self.predict(source, stream, **kwargs)

    def predict(
        self,
        source: Union[str, Path, int, list, tuple, np.ndarray, torch.Tensor] = None,
        stream: bool = False,
        predictor=None,
        **kwargs,
    ) -> List[Results]:
        """
        Performs predictions on the given image source using the YOLO model.

        This method facilitates the prediction process, allowing various configurations through keyword arguments.
        It supports predictions with custom predictors or the default predictor method. The method handles different
        types of image sources and can operate in a streaming mode. It also provides support for SAM-type models
        through 'prompts'.

        The method sets up a new predictor if not already present and updates its arguments with each call.
        It also issues a warning and uses default assets if the 'source' is not provided. The method determines if it
        is being called from the command line interface and adjusts its behavior accordingly, including setting defaults
        for confidence threshold and saving behavior.

        Args:
            source (str | int | PIL.Image | np.ndarray, optional): The source of the image for making predictions.
                Accepts various types, including file paths, URLs, PIL images, and numpy arrays. Defaults to ASSETS.
            stream (bool, optional): Treats the input source as a continuous stream for predictions. Defaults to False.
            predictor (BasePredictor, optional): An instance of a custom predictor class for making predictions.
                If None, the method uses a default predictor. Defaults to None.
            **kwargs (any): Additional keyword arguments for configuring the prediction process. These arguments allow
                for further customization of the prediction behavior.

        Returns:
            (List[ultralytics.engine.results.Results]): A list of prediction results, encapsulated in the Results class.

        Raises:
            AttributeError: If the predictor is not properly set up.
        """
        if source is None:
            source = ASSETS
            LOGGER.warning(f"WARNING ⚠️ 'source' is missing. Using 'source={source}'.")

        is_cli = (ARGV[0].endswith("yolo") or ARGV[0].endswith("ultralytics")) and any(
            x in ARGV for x in ("predict", "track", "mode=predict", "mode=track")
        )

        custom = {"conf": 0.25, "batch": 1, "save": is_cli, "mode": "predict"}  # method defaults
        args = {**self.overrides, **custom, **kwargs}  # highest priority args on the right
        prompts = args.pop("prompts", None)  # for SAM-type models

        if not self.predictor:
            self.predictor = predictor or self._smart_load("predictor")(overrides=args, _callbacks=self.callbacks)
            self.predictor.setup_model(model=self.model, verbose=is_cli)
        else:  # only update args if predictor is already setup
            self.predictor.args = get_cfg(self.predictor.args, args)
            if "project" in args or "name" in args:
                self.predictor.save_dir = get_save_dir(self.predictor.args)
        if prompts and hasattr(self.predictor, "set_prompts"):  # for SAM-type models
            self.predictor.set_prompts(prompts)
        return self.predictor.predict_cli(source=source) if is_cli else self.predictor(source=source, stream=stream)

    def track(
        self,
        source: Union[str, Path, int, list, tuple, np.ndarray, torch.Tensor] = None,
        stream: bool = False,
        persist: bool = False,
        **kwargs,
    ) -> List[Results]:
        """
        Conducts object tracking on the specified input source using the registered trackers.

        This method performs object tracking using the model's predictors and optionally registered trackers. It is
        capable of handling different types of input sources such as file paths or video streams. The method supports
        customization of the tracking process through various keyword arguments. It registers trackers if they are not
        already present and optionally persists them based on the 'persist' flag.

        The method sets a default confidence threshold specifically for ByteTrack-based tracking, which requires low
        confidence predictions as input. The tracking mode is explicitly set in the keyword arguments.

        Args:
            source (str, optional): The input source for object tracking. It can be a file path, URL, or video stream.
            stream (bool, optional): Treats the input source as a continuous video stream. Defaults to False.
            persist (bool, optional): Persists the trackers between different calls to this method. Defaults to False.
            **kwargs (any): Additional keyword arguments for configuring the tracking process. These arguments allow
                for further customization of the tracking behavior.

        Returns:
            (List[ultralytics.engine.results.Results]): A list of tracking results, encapsulated in the Results class.

        Raises:
            AttributeError: If the predictor does not have registered trackers.
        """
        if not hasattr(self.predictor, "trackers"):
            from ultralytics.trackers import register_tracker

            register_tracker(self, persist)
        kwargs["conf"] = kwargs.get("conf") or 0.1  # ByteTrack-based method needs low confidence predictions as input
        kwargs["batch"] = kwargs.get("batch") or 1  # batch-size 1 for tracking in videos
        kwargs["mode"] = "track"
        return self.predict(source=source, stream=stream, **kwargs)

    def val(
        self,
        validator=None,
        **kwargs,
    ):
        """
        Validates the model using a specified dataset and validation configuration.

        This method facilitates the model validation process, allowing for a range of customization through various
        settings and configurations. It supports validation with a custom validator or the default validation approach.
        The method combines default configurations, method-specific defaults, and user-provided arguments to configure
        the validation process. After validation, it updates the model's metrics with the results obtained from the
        validator.

        The method supports various arguments that allow customization of the validation process. For a comprehensive
        list of all configurable options, users should refer to the 'configuration' section in the documentation.

        Args:
            validator (BaseValidator, optional): An instance of a custom validator class for validating the model. If
                None, the method uses a default validator. Defaults to None.
            **kwargs (any): Arbitrary keyword arguments representing the validation configuration. These arguments are
                used to customize various aspects of the validation process.

        Returns:
            (dict): Validation metrics obtained from the validation process.

        Raises:
            AssertionError: If the model is not a PyTorch model.
        """
        custom = {"rect": True}  # method defaults
        args = {**self.overrides, **custom, **kwargs, "mode": "val"}  # highest priority args on the right

        validator = (validator or self._smart_load("validator"))(args=args, _callbacks=self.callbacks)
        validator(model=self.model)
        self.metrics = validator.metrics
        return validator.metrics

    def benchmark(
        self,
        **kwargs,
    ):
        """
        Benchmarks the model across various export formats to evaluate performance.

        This method assesses the model's performance in different export formats, such as ONNX, TorchScript, etc.
        It uses the 'benchmark' function from the ultralytics.utils.benchmarks module. The benchmarking is configured
        using a combination of default configuration values, model-specific arguments, method-specific defaults, and
        any additional user-provided keyword arguments.

        The method supports various arguments that allow customization of the benchmarking process, such as dataset
        choice, image size, precision modes, device selection, and verbosity. For a comprehensive list of all
        configurable options, users should refer to the 'configuration' section in the documentation.

        Args:
            **kwargs (any): Arbitrary keyword arguments to customize the benchmarking process. These are combined with
                default configurations, model-specific arguments, and method defaults.

        Returns:
            (dict): A dictionary containing the results of the benchmarking process.

        Raises:
            AssertionError: If the model is not a PyTorch model.
        """
        self._check_is_pytorch_model()
        from ultralytics.utils.benchmarks import benchmark

        custom = {"verbose": False}  # method defaults
        args = {**DEFAULT_CFG_DICT, **self.model.args, **custom, **kwargs, "mode": "benchmark"}
        return benchmark(
            model=self,
            data=kwargs.get("data"),  # if no 'data' argument passed set data=None for default datasets
            imgsz=args["imgsz"],
            half=args["half"],
            int8=args["int8"],
            device=args["device"],
            verbose=kwargs.get("verbose"),
        )

    def export(
        self,
        **kwargs,
    ) -> str:
        """
        Exports the model to a different format suitable for deployment.

        This method facilitates the export of the model to various formats (e.g., ONNX, TorchScript) for deployment
        purposes. It uses the 'Exporter' class for the export process, combining model-specific overrides, method
        defaults, and any additional arguments provided. The combined arguments are used to configure export settings.

        The method supports a wide range of arguments to customize the export process. For a comprehensive list of all
        possible arguments, refer to the 'configuration' section in the documentation.

        Args:
            **kwargs (any): Arbitrary keyword arguments to customize the export process. These are combined with the
                model's overrides and method defaults.

        Returns:
            (str): The exported model filename in the specified format, or an object related to the export process.

        Raises:
            AssertionError: If the model is not a PyTorch model.
        """
        self._check_is_pytorch_model()
        from .exporter import Exporter

        custom = {"imgsz": self.model.args["imgsz"], "batch": 1, "data": None, "verbose": False}  # method defaults
        args = {**self.overrides, **custom, **kwargs, "mode": "export"}  # highest priority args on the right
        return Exporter(overrides=args, _callbacks=self.callbacks)(model=self.model)

    def train(
        self,
        trainer=None,
        **kwargs,
    ):
        """
        Trains the model using the specified dataset and training configuration.

        This method facilitates model training with a range of customizable settings and configurations. It supports
        training with a custom trainer or the default training approach defined in the method. The method handles
        different scenarios, such as resuming training from a checkpoint, integrating with Ultralytics HUB, and
        updating model and configuration after training.

        When using Ultralytics HUB, if the session already has a loaded model, the method prioritizes HUB training
        arguments and issues a warning if local arguments are provided. It checks for pip updates and combines default
        configurations, method-specific defaults, and user-provided arguments to configure the training process. After
        training, it updates the model and its configurations, and optionally attaches metrics.

        Args:
            trainer (BaseTrainer, optional): An instance of a custom trainer class for training the model. If None, the
                method uses a default trainer. Defaults to None.
            **kwargs (any): Arbitrary keyword arguments representing the training configuration. These arguments are
                used to customize various aspects of the training process.

        Returns:
            (dict | None): Training metrics if available and training is successful; otherwise, None.

        Raises:
            AssertionError: If the model is not a PyTorch model.
            PermissionError: If there is a permission issue with the HUB session.
            ModuleNotFoundError: If the HUB SDK is not installed.
        """
        self._check_is_pytorch_model()
        if hasattr(self.session, "model") and self.session.model.id:  # Ultralytics HUB session with loaded model
            if any(kwargs):
                LOGGER.warning("WARNING ⚠️ using HUB training arguments, ignoring local training arguments.")
            kwargs = self.session.train_args  # overwrite kwargs

        checks.check_pip_update_available()

        overrides = yaml_load(checks.check_yaml(kwargs["cfg"])) if kwargs.get("cfg") else self.overrides
        custom = {
            # NOTE: handle the case when 'cfg' includes 'data'.
            "data": overrides.get("data") or DEFAULT_CFG_DICT["data"] or TASK2DATA[self.task],
            "model": self.overrides["model"],
            "task": self.task,
        }  # method defaults
        args = {**overrides, **custom, **kwargs, "mode": "train"}  # highest priority args on the right
        if args.get("resume"):
            args["resume"] = self.ckpt_path

        self.trainer = (trainer or self._smart_load("trainer"))(overrides=args, _callbacks=self.callbacks)
        if not args.get("resume"):  # manually set model only if not resuming
            self.trainer.model = self.trainer.get_model(weights=self.model if self.ckpt else None, cfg=self.model.yaml)
            self.model = self.trainer.model

            if SETTINGS["hub"] is True and not self.session:
                # Create a model in HUB
                try:
                    self.session = self._get_hub_session(self.model_name)
                    if self.session:
                        self.session.create_model(args)
                        # Check model was created
                        if not getattr(self.session.model, "id", None):
                            self.session = None
                except (PermissionError, ModuleNotFoundError):
                    # Ignore PermissionError and ModuleNotFoundError which indicates hub-sdk not installed
                    pass

        self.trainer.hub_session = self.session  # attach optional HUB session
        self.trainer.train()
        # Update model and cfg after training
        if RANK in {-1, 0}:
            ckpt = self.trainer.best if self.trainer.best.exists() else self.trainer.last
            self.model, _ = attempt_load_one_weight(ckpt)
            self.overrides = self.model.args
            self.metrics = getattr(self.trainer.validator, "metrics", None)  # TODO: no metrics returned by DDP
        return self.metrics

    def tune(
        self,
        use_ray=False,
        iterations=10,
        *args,
        **kwargs,
    ):
        """
        Conducts hyperparameter tuning for the model, with an option to use Ray Tune.

        This method supports two modes of hyperparameter tuning: using Ray Tune or a custom tuning method.
        When Ray Tune is enabled, it leverages the 'run_ray_tune' function from the ultralytics.utils.tuner module.
        Otherwise, it uses the internal 'Tuner' class for tuning. The method combines default, overridden, and
        custom arguments to configure the tuning process.

        Args:
            use_ray (bool): If True, uses Ray Tune for hyperparameter tuning. Defaults to False.
            iterations (int): The number of tuning iterations to perform. Defaults to 10.
            *args (list): Variable length argument list for additional arguments.
            **kwargs (any): Arbitrary keyword arguments. These are combined with the model's overrides and defaults.

        Returns:
            (dict): A dictionary containing the results of the hyperparameter search.

        Raises:
            AssertionError: If the model is not a PyTorch model.
        """
        self._check_is_pytorch_model()
        if use_ray:
            from ultralytics.utils.tuner import run_ray_tune

            return run_ray_tune(self, max_samples=iterations, *args, **kwargs)
        else:
            from .tuner import Tuner

            custom = {}  # method defaults
            args = {**self.overrides, **custom, **kwargs, "mode": "train"}  # highest priority args on the right
            return Tuner(args=args, _callbacks=self.callbacks)(model=self, iterations=iterations)

    def _apply(self, fn) -> "Model":
        """Apply to(), cpu(), cuda(), half(), float() to model tensors that are not parameters or registered buffers."""
        self._check_is_pytorch_model()
        self = super()._apply(fn)  # noqa
        self.predictor = None  # reset predictor as device may have changed
        self.overrides["device"] = self.device  # was str(self.device) i.e. device(type='cuda', index=0) -> 'cuda:0'
        return self

    @property
    def names(self) -> list:
        """
        Retrieves the class names associated with the loaded model.

        This property returns the class names if they are defined in the model. It checks the class names for validity
        using the 'check_class_names' function from the ultralytics.nn.autobackend module.

        Returns:
            (list | None): The class names of the model if available, otherwise None.
        """
        from ultralytics.nn.autobackend import check_class_names

        if hasattr(self.model, "names"):
            return check_class_names(self.model.names)
        if not self.predictor:  # export formats will not have predictor defined until predict() is called
            self.predictor = self._smart_load("predictor")(overrides=self.overrides, _callbacks=self.callbacks)
            self.predictor.setup_model(model=self.model, verbose=False)
        return self.predictor.model.names

    @property
    def device(self) -> torch.device:
        """
        Retrieves the device on which the model's parameters are allocated.

        This property is used to determine whether the model's parameters are on CPU or GPU. It only applies to models
        that are instances of nn.Module.

        Returns:
            (torch.device | None): The device (CPU/GPU) of the model if it is a PyTorch model, otherwise None.
        """
        return next(self.model.parameters()).device if isinstance(self.model, nn.Module) else None

    @property
    def transforms(self):
        """
        Retrieves the transformations applied to the input data of the loaded model.

        This property returns the transformations if they are defined in the model.

        Returns:
            (object | None): The transform object of the model if available, otherwise None.
        """
        return self.model.transforms if hasattr(self.model, "transforms") else None

    def add_callback(self, event: str, func) -> None:
        """
        Adds a callback function for a specified event.

        This method allows the user to register a custom callback function that is triggered on a specific event during
        model training or inference.

        Args:
            event (str): The name of the event to attach the callback to.
            func (callable): The callback function to be registered.

        Raises:
            ValueError: If the event name is not recognized.
        """
        self.callbacks[event].append(func)

    def clear_callback(self, event: str) -> None:
        """
        Clears all callback functions registered for a specified event.

        This method removes all custom and default callback functions associated with the given event.

        Args:
            event (str): The name of the event for which to clear the callbacks.

        Raises:
            ValueError: If the event name is not recognized.
        """
        self.callbacks[event] = []

    def reset_callbacks(self) -> None:
        """
        Resets all callbacks to their default functions.

        This method reinstates the default callback functions for all events, removing any custom callbacks that were
        added previously.
        """
        for event in callbacks.default_callbacks.keys():
            self.callbacks[event] = [callbacks.default_callbacks[event][0]]

    @staticmethod
    def _reset_ckpt_args(args: dict) -> dict:
        """Reset arguments when loading a PyTorch model."""
        include = {"imgsz", "data", "task", "single_cls"}  # only remember these arguments when loading a PyTorch model
        return {k: v for k, v in args.items() if k in include}

    # def __getattr__(self, attr):
    #    """Raises error if object has no requested attribute."""
    #    name = self.__class__.__name__
    #    raise AttributeError(f"'{name}' object has no attribute '{attr}'. See valid attributes below.\n{self.__doc__}")

    def _smart_load(self, key: str):
        """Load model/trainer/validator/predictor."""
        try:
            return self.task_map[self.task][key]
        except Exception as e:
            name = self.__class__.__name__
            mode = inspect.stack()[1][3]  # get the function name.
            raise NotImplementedError(
                emojis(f"WARNING ⚠️ '{name}' model does not support '{mode}' mode for '{self.task}' task yet.")
            ) from e

    @property
    def task_map(self) -> dict:
        """
        Map head to model, trainer, validator, and predictor classes.

        Returns:
            task_map (dict): The map of model task to mode classes.
        """
        raise NotImplementedError("Please provide task map for your model!")

device: torch.device property

Truy xuất thiết bị mà các tham số của mô hình được phân bổ.

Thuộc tính này được sử dụng để xác định xem các tham số của mô hình nằm trên CPU hay GPU. Nó chỉ áp dụng cho các mô hình Đó là những trường hợp của NN. Module.

Trở lại:

Kiểu Sự miêu tả
device | None

Thiết bị (CPU / GPU) của model nếu là PyTorch mô hình, nếu không thì Không có.

names: list property

Truy xuất tên lớp được liên kết với mô hình đã tải.

Thuộc tính này trả về tên lớp nếu chúng được xác định trong mô hình. Nó kiểm tra tính hợp lệ của tên lớp sử dụng chức năng 'check_class_names' từ ultralyticsMô-đun .nn.autobackend.

Trở lại:

Kiểu Sự miêu tả
list | None

Tên lớp của mô hình nếu có, nếu không thì Không có.

task_map: dict property

Ánh xạ đầu đến các lớp mô hình, huấn luyện viên, trình xác nhận và dự đoán.

Trở lại:

Tên Kiểu Sự miêu tả
task_map dict

Bản đồ của tác vụ mô hình đến các lớp chế độ.

transforms property

Truy xuất các phép biến đổi được áp dụng cho dữ liệu đầu vào của mô hình được tải.

Thuộc tính này trả về các phép biến đổi nếu chúng được xác định trong mô hình.

Trở lại:

Kiểu Sự miêu tả
object | None

Đối tượng biến đổi của mô hình nếu có, nếu không thì Không có.

__call__(source=None, stream=False, **kwargs)

Một bí danh cho phương thức predict, cho phép đối tượng mô hình có thể gọi được.

Phương pháp này đơn giản hóa quá trình đưa ra dự đoán bằng cách cho phép gọi trực tiếp đối tượng mô hình với các đối số cần thiết để dự đoán.

Thông số:

Tên Kiểu Sự miêu tả Mặc định
source str | Path | int | Image | ndarray

Nguồn gốc của hình ảnh để thực hiện Dự đoán. Chấp nhận nhiều loại khác nhau, bao gồm đường dẫn tệp, URL, hình ảnh PIL và mảng numpy. Mặc định là Không có.

None
stream bool

Nếu True, hãy coi nguồn đầu vào là một luồng liên tục để dự đoán. Mặc định là False.

False
**kwargs any

Đối số từ khóa bổ sung để định cấu hình quy trình dự đoán.

{}

Trở lại:

Kiểu Sự miêu tả
List[Results]

Một danh sách các kết quả dự đoán, được gói gọn trong lớp Kết quả.

Mã nguồn trong ultralytics/engine/model.py
def __call__(
    self,
    source: Union[str, Path, int, list, tuple, np.ndarray, torch.Tensor] = None,
    stream: bool = False,
    **kwargs,
) -> list:
    """
    An alias for the predict method, enabling the model instance to be callable.

    This method simplifies the process of making predictions by allowing the model instance to be called directly
    with the required arguments for prediction.

    Args:
        source (str | Path | int | PIL.Image | np.ndarray, optional): The source of the image for making
            predictions. Accepts various types, including file paths, URLs, PIL images, and numpy arrays.
            Defaults to None.
        stream (bool, optional): If True, treats the input source as a continuous stream for predictions.
            Defaults to False.
        **kwargs (any): Additional keyword arguments for configuring the prediction process.

    Returns:
        (List[ultralytics.engine.results.Results]): A list of prediction results, encapsulated in the Results class.
    """
    return self.predict(source, stream, **kwargs)

__init__(model='yolov8n.pt', task=None, verbose=False)

Khởi tạo một thể hiện mới của YOLO lớp mô hình.

Hàm tạo này thiết lập mô hình dựa trên đường dẫn hoặc tên mô hình được cung cấp. Nó xử lý các loại mô hình khác nhau nguồn, bao gồm các tệp cục bộ, Ultralytics Các mô hình HUB và Triton Mô hình máy chủ. Phương thức khởi tạo một số các thuộc tính quan trọng của mô hình và chuẩn bị nó cho các hoạt động như đào tạo, dự đoán hoặc xuất.

Thông số:

Tên Kiểu Sự miêu tả Mặc định
model Union[str, Path]

Tệp đường dẫn hoặc mô hình để tải hoặc tạo. Đây có thể là một địa phương Đường dẫn tệp, tên mô hình từ Ultralytics HUB hoặc một Triton Mô hình máy chủ. Mặc định là 'yolov8n.pt'.

'yolov8n.pt'
task Any

Loại tác vụ được liên kết với YOLO mô hình, chỉ định miền ứng dụng của nó. Mặc định là Không có.

None
verbose bool

Nếu True, cho phép đầu ra chi tiết trong quá trình khởi tạo mô hình và tiếp theo Hoạt động. Mặc định là False.

False

Tăng:

Kiểu Sự miêu tả
FileNotFoundError

Nếu tệp mô hình được chỉ định không tồn tại hoặc không thể truy cập được.

ValueError

Nếu tệp mô hình hoặc cấu hình không hợp lệ hoặc không được hỗ trợ.

ImportError

Nếu được yêu cầu, các phần phụ thuộc cho các loại mô hình cụ thể (như HUB SDK) sẽ không được cài đặt.

Mã nguồn trong ultralytics/engine/model.py
def __init__(
    self,
    model: Union[str, Path] = "yolov8n.pt",
    task: str = None,
    verbose: bool = False,
) -> None:
    """
    Initializes a new instance of the YOLO model class.

    This constructor sets up the model based on the provided model path or name. It handles various types of model
    sources, including local files, Ultralytics HUB models, and Triton Server models. The method initializes several
    important attributes of the model and prepares it for operations like training, prediction, or export.

    Args:
        model (Union[str, Path], optional): The path or model file to load or create. This can be a local
            file path, a model name from Ultralytics HUB, or a Triton Server model. Defaults to 'yolov8n.pt'.
        task (Any, optional): The task type associated with the YOLO model, specifying its application domain.
            Defaults to None.
        verbose (bool, optional): If True, enables verbose output during the model's initialization and subsequent
            operations. Defaults to False.

    Raises:
        FileNotFoundError: If the specified model file does not exist or is inaccessible.
        ValueError: If the model file or configuration is invalid or unsupported.
        ImportError: If required dependencies for specific model types (like HUB SDK) are not installed.
    """
    super().__init__()
    self.callbacks = callbacks.get_default_callbacks()
    self.predictor = None  # reuse predictor
    self.model = None  # model object
    self.trainer = None  # trainer object
    self.ckpt = None  # if loaded from *.pt
    self.cfg = None  # if loaded from *.yaml
    self.ckpt_path = None
    self.overrides = {}  # overrides for trainer object
    self.metrics = None  # validation/training metrics
    self.session = None  # HUB session
    self.task = task  # task type
    model = str(model).strip()

    # Check if Ultralytics HUB model from https://hub.ultralytics.com
    if self.is_hub_model(model):
        # Fetch model from HUB
        checks.check_requirements("hub-sdk>=0.0.6")
        self.session = self._get_hub_session(model)
        model = self.session.model_file

    # Check if Triton Server model
    elif self.is_triton_model(model):
        self.model_name = self.model = model
        self.task = task
        return

    # Load or create new YOLO model
    if Path(model).suffix in {".yaml", ".yml"}:
        self._new(model, task=task, verbose=verbose)
    else:
        self._load(model, task=task)

add_callback(event, func)

Thêm hàm gọi lại cho một sự kiện cụ thể.

Phương pháp này cho phép người dùng đăng ký một hàm gọi lại tùy chỉnh được kích hoạt trên một sự kiện cụ thể trong đào tạo mô hình hoặc suy luận.

Thông số:

Tên Kiểu Sự miêu tả Mặc định
event str

Tên của sự kiện để đính kèm callback đến.

bắt buộc
func callable

Hàm callback sẽ được đăng ký.

bắt buộc

Tăng:

Kiểu Sự miêu tả
ValueError

Nếu tên sự kiện không được nhận dạng.

Mã nguồn trong ultralytics/engine/model.py
def add_callback(self, event: str, func) -> None:
    """
    Adds a callback function for a specified event.

    This method allows the user to register a custom callback function that is triggered on a specific event during
    model training or inference.

    Args:
        event (str): The name of the event to attach the callback to.
        func (callable): The callback function to be registered.

    Raises:
        ValueError: If the event name is not recognized.
    """
    self.callbacks[event].append(func)

benchmark(**kwargs)

Điểm chuẩn mô hình trên các định dạng xuất khác nhau để đánh giá hiệu suất.

Phương pháp này đánh giá hiệu suất của mô hình ở các định dạng xuất khác nhau, chẳng hạn như ONNX, TorchScriptv.v. Nó sử dụng chức năng 'benchmark' từ ultralyticsmô-đun .utils.benchmarks. Điểm chuẩn được cấu hình sử dụng kết hợp các giá trị cấu hình mặc định, đối số dành riêng cho mô hình, mặc định dành riêng cho phương thức và bất kỳ đối số từ khóa bổ sung nào do người dùng cung cấp.

Phương pháp này hỗ trợ các đối số khác nhau cho phép tùy chỉnh quá trình đo điểm chuẩn, chẳng hạn như tập dữ liệu Lựa chọn, kích thước hình ảnh, chế độ chính xác, lựa chọn thiết bị và độ chi tiết. Để có danh sách đầy đủ về tất cả Tùy chọn cấu hình, người dùng nên tham khảo phần 'Cấu hình' trong tài liệu.

Thông số:

Tên Kiểu Sự miêu tả Mặc định
**kwargs any

Đối số từ khóa tùy ý để tùy chỉnh quá trình đo điểm chuẩn. Chúng được kết hợp với cấu hình mặc định, đối số dành riêng cho mô hình và mặc định phương thức.

{}

Trở lại:

Kiểu Sự miêu tả
dict

Một từ điển chứa kết quả của quá trình đo điểm chuẩn.

Tăng:

Kiểu Sự miêu tả
AssertionError

Nếu mô hình không phải là một PyTorch mẫu.

Mã nguồn trong ultralytics/engine/model.py
def benchmark(
    self,
    **kwargs,
):
    """
    Benchmarks the model across various export formats to evaluate performance.

    This method assesses the model's performance in different export formats, such as ONNX, TorchScript, etc.
    It uses the 'benchmark' function from the ultralytics.utils.benchmarks module. The benchmarking is configured
    using a combination of default configuration values, model-specific arguments, method-specific defaults, and
    any additional user-provided keyword arguments.

    The method supports various arguments that allow customization of the benchmarking process, such as dataset
    choice, image size, precision modes, device selection, and verbosity. For a comprehensive list of all
    configurable options, users should refer to the 'configuration' section in the documentation.

    Args:
        **kwargs (any): Arbitrary keyword arguments to customize the benchmarking process. These are combined with
            default configurations, model-specific arguments, and method defaults.

    Returns:
        (dict): A dictionary containing the results of the benchmarking process.

    Raises:
        AssertionError: If the model is not a PyTorch model.
    """
    self._check_is_pytorch_model()
    from ultralytics.utils.benchmarks import benchmark

    custom = {"verbose": False}  # method defaults
    args = {**DEFAULT_CFG_DICT, **self.model.args, **custom, **kwargs, "mode": "benchmark"}
    return benchmark(
        model=self,
        data=kwargs.get("data"),  # if no 'data' argument passed set data=None for default datasets
        imgsz=args["imgsz"],
        half=args["half"],
        int8=args["int8"],
        device=args["device"],
        verbose=kwargs.get("verbose"),
    )

clear_callback(event)

Xóa tất cả các hàm gọi lại đã đăng ký cho một sự kiện cụ thể.

Phương thức này loại bỏ tất cả các hàm callback tùy chỉnh và mặc định được liên kết với sự kiện đã cho.

Thông số:

Tên Kiểu Sự miêu tả Mặc định
event str

Tên của sự kiện để xóa callback.

bắt buộc

Tăng:

Kiểu Sự miêu tả
ValueError

Nếu tên sự kiện không được nhận dạng.

Mã nguồn trong ultralytics/engine/model.py
def clear_callback(self, event: str) -> None:
    """
    Clears all callback functions registered for a specified event.

    This method removes all custom and default callback functions associated with the given event.

    Args:
        event (str): The name of the event for which to clear the callbacks.

    Raises:
        ValueError: If the event name is not recognized.
    """
    self.callbacks[event] = []

embed(source=None, stream=False, **kwargs)

Tạo nhúng hình ảnh dựa trên nguồn được cung cấp.

Phương thức này là một wrapper xung quanh phương thức 'predict()', tập trung vào việc tạo nhúng từ nguồn hình ảnh. Nó cho phép tùy chỉnh quá trình nhúng thông qua các đối số từ khóa khác nhau.

Thông số:

Tên Kiểu Sự miêu tả Mặc định
source str | int | Image | ndarray

Nguồn của hình ảnh để tạo nhúng. Nguồn có thể là đường dẫn tệp, URL, hình ảnh PIL, mảng numpy, v.v. Mặc định là Không có.

None
stream bool

Nếu Đúng, các dự đoán sẽ được phát trực tuyến. Mặc định là False.

False
**kwargs any

Đối số từ khóa bổ sung để định cấu hình quá trình nhúng.

{}

Trở lại:

Kiểu Sự miêu tả
List[Tensor]

Danh sách chứa nhúng hình ảnh.

Tăng:

Kiểu Sự miêu tả
AssertionError

Nếu mô hình không phải là một PyTorch mẫu.

Mã nguồn trong ultralytics/engine/model.py
def embed(
    self,
    source: Union[str, Path, int, list, tuple, np.ndarray, torch.Tensor] = None,
    stream: bool = False,
    **kwargs,
) -> list:
    """
    Generates image embeddings based on the provided source.

    This method is a wrapper around the 'predict()' method, focusing on generating embeddings from an image source.
    It allows customization of the embedding process through various keyword arguments.

    Args:
        source (str | int | PIL.Image | np.ndarray): The source of the image for generating embeddings.
            The source can be a file path, URL, PIL image, numpy array, etc. Defaults to None.
        stream (bool): If True, predictions are streamed. Defaults to False.
        **kwargs (any): Additional keyword arguments for configuring the embedding process.

    Returns:
        (List[torch.Tensor]): A list containing the image embeddings.

    Raises:
        AssertionError: If the model is not a PyTorch model.
    """
    if not kwargs.get("embed"):
        kwargs["embed"] = [len(self.model.model) - 2]  # embed second-to-last layer if no indices passed
    return self.predict(source, stream, **kwargs)

export(**kwargs)

Xuất mô hình sang định dạng khác phù hợp để triển khai.

Phương pháp này tạo điều kiện thuận lợi cho việc xuất mô hình sang các định dạng khác nhau (ví dụ: ONNX, TorchScript) để triển khai Mục đích. Nó sử dụng lớp 'Exporter' cho quá trình xuất, kết hợp ghi đè mô hình cụ thể, phương thức mặc định và bất kỳ đối số bổ sung nào được cung cấp. Các đối số kết hợp được sử dụng để định cấu hình cài đặt xuất.

Phương pháp này hỗ trợ một loạt các đối số để tùy chỉnh quá trình xuất. Để có danh sách đầy đủ về tất cả Các đối số có thể có, hãy tham khảo phần 'Cấu hình' trong tài liệu.

Thông số:

Tên Kiểu Sự miêu tả Mặc định
**kwargs any

Đối số từ khóa tùy ý để tùy chỉnh quy trình xuất. Chúng được kết hợp với Ghi đè của mô hình và mặc định phương thức.

{}

Trở lại:

Kiểu Sự miêu tả
str

Tên tệp mô hình đã xuất ở định dạng được chỉ định hoặc một đối tượng liên quan đến quá trình xuất.

Tăng:

Kiểu Sự miêu tả
AssertionError

Nếu mô hình không phải là một PyTorch mẫu.

Mã nguồn trong ultralytics/engine/model.py
def export(
    self,
    **kwargs,
) -> str:
    """
    Exports the model to a different format suitable for deployment.

    This method facilitates the export of the model to various formats (e.g., ONNX, TorchScript) for deployment
    purposes. It uses the 'Exporter' class for the export process, combining model-specific overrides, method
    defaults, and any additional arguments provided. The combined arguments are used to configure export settings.

    The method supports a wide range of arguments to customize the export process. For a comprehensive list of all
    possible arguments, refer to the 'configuration' section in the documentation.

    Args:
        **kwargs (any): Arbitrary keyword arguments to customize the export process. These are combined with the
            model's overrides and method defaults.

    Returns:
        (str): The exported model filename in the specified format, or an object related to the export process.

    Raises:
        AssertionError: If the model is not a PyTorch model.
    """
    self._check_is_pytorch_model()
    from .exporter import Exporter

    custom = {"imgsz": self.model.args["imgsz"], "batch": 1, "data": None, "verbose": False}  # method defaults
    args = {**self.overrides, **custom, **kwargs, "mode": "export"}  # highest priority args on the right
    return Exporter(overrides=args, _callbacks=self.callbacks)(model=self.model)

fuse()

Cầu chì các lớp Conv2d và BatchNorm2d trong mô hình.

Phương pháp này tối ưu hóa mô hình bằng cách hợp nhất các lớp Conv2d và BatchNorm2d, có thể cải thiện tốc độ suy luận.

Tăng:

Kiểu Sự miêu tả
AssertionError

Nếu mô hình không phải là một PyTorch mẫu.

Mã nguồn trong ultralytics/engine/model.py
def fuse(self):
    """
    Fuses Conv2d and BatchNorm2d layers in the model.

    This method optimizes the model by fusing Conv2d and BatchNorm2d layers, which can improve inference speed.

    Raises:
        AssertionError: If the model is not a PyTorch model.
    """
    self._check_is_pytorch_model()
    self.model.fuse()

info(detailed=False, verbose=True)

Ghi nhật ký hoặc trả về thông tin mô hình.

Phương pháp này cung cấp tổng quan hoặc thông tin chi tiết về mô hình, tùy thuộc vào các đối số được thông qua. Nó có thể kiểm soát độ chi tiết của đầu ra.

Thông số:

Tên Kiểu Sự miêu tả Mặc định
detailed bool

Nếu True, hiển thị thông tin chi tiết về mô hình. Mặc định là False.

False
verbose bool

Nếu True, in thông tin. Nếu False, trả về thông tin. Mặc định là True.

True

Trở lại:

Kiểu Sự miêu tả
list

Nhiều loại thông tin khác nhau về mô hình, tùy thuộc vào các thông số 'chi tiết' và 'dài dòng'.

Tăng:

Kiểu Sự miêu tả
AssertionError

Nếu mô hình không phải là một PyTorch mẫu.

Mã nguồn trong ultralytics/engine/model.py
def info(self, detailed: bool = False, verbose: bool = True):
    """
    Logs or returns model information.

    This method provides an overview or detailed information about the model, depending on the arguments passed.
    It can control the verbosity of the output.

    Args:
        detailed (bool): If True, shows detailed information about the model. Defaults to False.
        verbose (bool): If True, prints the information. If False, returns the information. Defaults to True.

    Returns:
        (list): Various types of information about the model, depending on the 'detailed' and 'verbose' parameters.

    Raises:
        AssertionError: If the model is not a PyTorch model.
    """
    self._check_is_pytorch_model()
    return self.model.info(detailed=detailed, verbose=verbose)

is_hub_model(model) staticmethod

Kiểm tra xem mô hình được cung cấp có phải là mô hình HUB hay không.

Mã nguồn trong ultralytics/engine/model.py
@staticmethod
def is_hub_model(model: str) -> bool:
    """Check if the provided model is a HUB model."""
    return any(
        (
            model.startswith(f"{HUB_WEB_ROOT}/models/"),  # i.e. https://hub.ultralytics.com/models/MODEL_ID
            [len(x) for x in model.split("_")] == [42, 20],  # APIKEY_MODEL
            len(model) == 20 and not Path(model).exists() and all(x not in model for x in "./\\"),  # MODEL
        )
    )

is_triton_model(model) staticmethod

Là mô hình a Triton Chuỗi URL máy chủ, tức là :////

Mã nguồn trong ultralytics/engine/model.py
@staticmethod
def is_triton_model(model: str) -> bool:
    """Is model a Triton Server URL string, i.e. <scheme>://<netloc>/<endpoint>/<task_name>"""
    from urllib.parse import urlsplit

    url = urlsplit(model)
    return url.netloc and url.path and url.scheme in {"http", "grpc"}

load(weights='yolov8n.pt')

Tải các tham số từ tệp trọng lượng được chỉ định vào mô hình.

Phương pháp này hỗ trợ tải trọng số từ một tệp hoặc trực tiếp từ một đối tượng trọng số. Nó khớp với các tham số bằng Tên và hình dạng và chuyển chúng sang mô hình.

Thông số:

Tên Kiểu Sự miêu tả Mặc định
weights str | Path

Đường dẫn đến tệp trọng số hoặc đối tượng trọng lượng. Mặc định là 'yolov8n.pt'.

'yolov8n.pt'

Trở lại:

Tên Kiểu Sự miêu tả
self Model

Trường hợp của lớp với trọng số tải.

Tăng:

Kiểu Sự miêu tả
AssertionError

Nếu mô hình không phải là một PyTorch mẫu.

Mã nguồn trong ultralytics/engine/model.py
def load(self, weights: Union[str, Path] = "yolov8n.pt") -> "Model":
    """
    Loads parameters from the specified weights file into the model.

    This method supports loading weights from a file or directly from a weights object. It matches parameters by
    name and shape and transfers them to the model.

    Args:
        weights (str | Path): Path to the weights file or a weights object. Defaults to 'yolov8n.pt'.

    Returns:
        self (ultralytics.engine.model.Model): The instance of the class with loaded weights.

    Raises:
        AssertionError: If the model is not a PyTorch model.
    """
    self._check_is_pytorch_model()
    if isinstance(weights, (str, Path)):
        weights, self.ckpt = attempt_load_one_weight(weights)
    self.model.load(weights)
    return self

predict(source=None, stream=False, predictor=None, **kwargs)

Thực hiện dự đoán về nguồn hình ảnh đã cho bằng cách sử dụng YOLO mẫu.

Phương pháp này tạo điều kiện thuận lợi cho quá trình dự đoán, cho phép các cấu hình khác nhau thông qua các đối số từ khóa. Nó hỗ trợ dự đoán với các công cụ dự đoán tùy chỉnh hoặc phương pháp dự đoán mặc định. Phương pháp xử lý khác nhau các loại nguồn hình ảnh và có thể hoạt động ở chế độ phát trực tuyến. Nó cũng cung cấp hỗ trợ cho SAM-loại mô hình thông qua 'lời nhắc'.

Phương thức thiết lập một công cụ dự đoán mới nếu chưa có và cập nhật các đối số của nó với mỗi cuộc gọi. Nó cũng đưa ra cảnh báo và sử dụng tài sản mặc định nếu 'nguồn' không được cung cấp. Phương pháp xác định xem nó có hay không đang được gọi từ giao diện dòng lệnh và điều chỉnh hành vi của nó cho phù hợp, bao gồm cả việc đặt mặc định cho ngưỡng tin cậy và hành vi tiết kiệm.

Thông số:

Tên Kiểu Sự miêu tả Mặc định
source str | int | Image | ndarray

Nguồn của hình ảnh để đưa ra dự đoán. Chấp nhận nhiều loại khác nhau, bao gồm đường dẫn tệp, URL, hình ảnh PIL và mảng numpy. Mặc định là TÀI SẢN.

None
stream bool

Xử lý nguồn đầu vào như một luồng liên tục để dự đoán. Mặc định là False.

False
predictor BasePredictor

Một ví dụ của một lớp dự đoán tùy chỉnh để đưa ra dự đoán. Nếu Không, phương thức sử dụng bộ dự đoán mặc định. Mặc định là Không có.

None
**kwargs any

Đối số từ khóa bổ sung để định cấu hình quy trình dự đoán. Những đối số này cho phép để tùy chỉnh thêm hành vi dự đoán.

{}

Trở lại:

Kiểu Sự miêu tả
List[Results]

Một danh sách các kết quả dự đoán, được gói gọn trong lớp Kết quả.

Tăng:

Kiểu Sự miêu tả
AttributeError

Nếu bộ dự đoán không được thiết lập đúng cách.

Mã nguồn trong ultralytics/engine/model.py
def predict(
    self,
    source: Union[str, Path, int, list, tuple, np.ndarray, torch.Tensor] = None,
    stream: bool = False,
    predictor=None,
    **kwargs,
) -> List[Results]:
    """
    Performs predictions on the given image source using the YOLO model.

    This method facilitates the prediction process, allowing various configurations through keyword arguments.
    It supports predictions with custom predictors or the default predictor method. The method handles different
    types of image sources and can operate in a streaming mode. It also provides support for SAM-type models
    through 'prompts'.

    The method sets up a new predictor if not already present and updates its arguments with each call.
    It also issues a warning and uses default assets if the 'source' is not provided. The method determines if it
    is being called from the command line interface and adjusts its behavior accordingly, including setting defaults
    for confidence threshold and saving behavior.

    Args:
        source (str | int | PIL.Image | np.ndarray, optional): The source of the image for making predictions.
            Accepts various types, including file paths, URLs, PIL images, and numpy arrays. Defaults to ASSETS.
        stream (bool, optional): Treats the input source as a continuous stream for predictions. Defaults to False.
        predictor (BasePredictor, optional): An instance of a custom predictor class for making predictions.
            If None, the method uses a default predictor. Defaults to None.
        **kwargs (any): Additional keyword arguments for configuring the prediction process. These arguments allow
            for further customization of the prediction behavior.

    Returns:
        (List[ultralytics.engine.results.Results]): A list of prediction results, encapsulated in the Results class.

    Raises:
        AttributeError: If the predictor is not properly set up.
    """
    if source is None:
        source = ASSETS
        LOGGER.warning(f"WARNING ⚠️ 'source' is missing. Using 'source={source}'.")

    is_cli = (ARGV[0].endswith("yolo") or ARGV[0].endswith("ultralytics")) and any(
        x in ARGV for x in ("predict", "track", "mode=predict", "mode=track")
    )

    custom = {"conf": 0.25, "batch": 1, "save": is_cli, "mode": "predict"}  # method defaults
    args = {**self.overrides, **custom, **kwargs}  # highest priority args on the right
    prompts = args.pop("prompts", None)  # for SAM-type models

    if not self.predictor:
        self.predictor = predictor or self._smart_load("predictor")(overrides=args, _callbacks=self.callbacks)
        self.predictor.setup_model(model=self.model, verbose=is_cli)
    else:  # only update args if predictor is already setup
        self.predictor.args = get_cfg(self.predictor.args, args)
        if "project" in args or "name" in args:
            self.predictor.save_dir = get_save_dir(self.predictor.args)
    if prompts and hasattr(self.predictor, "set_prompts"):  # for SAM-type models
        self.predictor.set_prompts(prompts)
    return self.predictor.predict_cli(source=source) if is_cli else self.predictor(source=source, stream=stream)

reset_callbacks()

Đặt lại tất cả các callback về chức năng mặc định của chúng.

Phương thức này khôi phục các hàm callback mặc định cho tất cả các sự kiện, loại bỏ mọi callback tùy chỉnh được thêm vào trước đó.

Mã nguồn trong ultralytics/engine/model.py
def reset_callbacks(self) -> None:
    """
    Resets all callbacks to their default functions.

    This method reinstates the default callback functions for all events, removing any custom callbacks that were
    added previously.
    """
    for event in callbacks.default_callbacks.keys():
        self.callbacks[event] = [callbacks.default_callbacks[event][0]]

reset_weights()

Đặt lại các tham số mô hình thành các giá trị khởi tạo ngẫu nhiên, loại bỏ hiệu quả tất cả thông tin đào tạo.

Phương thức này lặp qua tất cả các mô-đun trong mô hình và đặt lại các tham số của chúng nếu chúng có Phương pháp 'reset_parameters'. Nó cũng đảm bảo rằng tất cả các tham số có 'requires_grad' được đặt thành True, cho phép chúng được cập nhật trong quá trình đào tạo.

Trở lại:

Tên Kiểu Sự miêu tả
self Model

Phiên bản của lớp với trọng số đặt lại.

Tăng:

Kiểu Sự miêu tả
AssertionError

Nếu mô hình không phải là một PyTorch mẫu.

Mã nguồn trong ultralytics/engine/model.py
def reset_weights(self) -> "Model":
    """
    Resets the model parameters to randomly initialized values, effectively discarding all training information.

    This method iterates through all modules in the model and resets their parameters if they have a
    'reset_parameters' method. It also ensures that all parameters have 'requires_grad' set to True, enabling them
    to be updated during training.

    Returns:
        self (ultralytics.engine.model.Model): The instance of the class with reset weights.

    Raises:
        AssertionError: If the model is not a PyTorch model.
    """
    self._check_is_pytorch_model()
    for m in self.model.modules():
        if hasattr(m, "reset_parameters"):
            m.reset_parameters()
    for p in self.model.parameters():
        p.requires_grad = True
    return self

save(filename='saved_model.pt', use_dill=True)

Lưu trạng thái mô hình hiện tại vào một tệp.

Phương pháp này xuất điểm kiểm tra của mô hình (ckpt) sang tên tệp được chỉ định.

Thông số:

Tên Kiểu Sự miêu tả Mặc định
filename str | Path

Tên của tệp để lưu mô hình vào. Mặc định là 'saved_model.pt'.

'saved_model.pt'
use_dill bool

Có nên thử sử dụng thì là để lập số sê-ri hóa nếu có hay không. Mặc định là True.

True

Tăng:

Kiểu Sự miêu tả
AssertionError

Nếu mô hình không phải là một PyTorch mẫu.

Mã nguồn trong ultralytics/engine/model.py
def save(self, filename: Union[str, Path] = "saved_model.pt", use_dill=True) -> None:
    """
    Saves the current model state to a file.

    This method exports the model's checkpoint (ckpt) to the specified filename.

    Args:
        filename (str | Path): The name of the file to save the model to. Defaults to 'saved_model.pt'.
        use_dill (bool): Whether to try using dill for serialization if available. Defaults to True.

    Raises:
        AssertionError: If the model is not a PyTorch model.
    """
    self._check_is_pytorch_model()
    from datetime import datetime

    from ultralytics import __version__

    updates = {
        "date": datetime.now().isoformat(),
        "version": __version__,
        "license": "AGPL-3.0 License (https://ultralytics.com/license)",
        "docs": "https://docs.ultralytics.com",
    }
    torch.save({**self.ckpt, **updates}, filename, use_dill=use_dill)

track(source=None, stream=False, persist=False, **kwargs)

Tiến hành theo dõi đối tượng trên nguồn đầu vào được chỉ định bằng cách sử dụng các trình theo dõi đã đăng ký.

Phương pháp này thực hiện theo dõi đối tượng bằng cách sử dụng các công cụ dự đoán của mô hình và trình theo dõi được đăng ký tùy chọn. Đó là Có khả năng xử lý các loại nguồn đầu vào khác nhau như đường dẫn tệp hoặc luồng video. Phương pháp hỗ trợ Tùy chỉnh quy trình theo dõi thông qua các đối số từ khóa khác nhau. Nó đăng ký trình theo dõi nếu chúng không đã có mặt và tùy chọn duy trì chúng dựa trên cờ 'kiên trì'.

Phương pháp này đặt ngưỡng tin cậy mặc định dành riêng cho theo dõi dựa trên ByteTrack, yêu cầu thấp dự đoán niềm tin làm đầu vào. Chế độ theo dõi được đặt rõ ràng trong các đối số từ khóa.

Thông số:

Tên Kiểu Sự miêu tả Mặc định
source str

Nguồn đầu vào để theo dõi đối tượng. Nó có thể là đường dẫn tệp, URL hoặc luồng video.

None
stream bool

Xử lý nguồn đầu vào như một luồng video liên tục. Mặc định là False.

False
persist bool

Vẫn duy trì các trình theo dõi giữa các cuộc gọi khác nhau đến phương pháp này. Mặc định là False.

False
**kwargs any

Đối số từ khóa bổ sung để định cấu hình quy trình theo dõi. Những đối số này cho phép để tùy chỉnh thêm hành vi theo dõi.

{}

Trở lại:

Kiểu Sự miêu tả
List[Results]

Một danh sách các kết quả theo dõi, được gói gọn trong lớp Kết quả.

Tăng:

Kiểu Sự miêu tả
AttributeError

Nếu công cụ dự đoán không có trình theo dõi đã đăng ký.

Mã nguồn trong ultralytics/engine/model.py
def track(
    self,
    source: Union[str, Path, int, list, tuple, np.ndarray, torch.Tensor] = None,
    stream: bool = False,
    persist: bool = False,
    **kwargs,
) -> List[Results]:
    """
    Conducts object tracking on the specified input source using the registered trackers.

    This method performs object tracking using the model's predictors and optionally registered trackers. It is
    capable of handling different types of input sources such as file paths or video streams. The method supports
    customization of the tracking process through various keyword arguments. It registers trackers if they are not
    already present and optionally persists them based on the 'persist' flag.

    The method sets a default confidence threshold specifically for ByteTrack-based tracking, which requires low
    confidence predictions as input. The tracking mode is explicitly set in the keyword arguments.

    Args:
        source (str, optional): The input source for object tracking. It can be a file path, URL, or video stream.
        stream (bool, optional): Treats the input source as a continuous video stream. Defaults to False.
        persist (bool, optional): Persists the trackers between different calls to this method. Defaults to False.
        **kwargs (any): Additional keyword arguments for configuring the tracking process. These arguments allow
            for further customization of the tracking behavior.

    Returns:
        (List[ultralytics.engine.results.Results]): A list of tracking results, encapsulated in the Results class.

    Raises:
        AttributeError: If the predictor does not have registered trackers.
    """
    if not hasattr(self.predictor, "trackers"):
        from ultralytics.trackers import register_tracker

        register_tracker(self, persist)
    kwargs["conf"] = kwargs.get("conf") or 0.1  # ByteTrack-based method needs low confidence predictions as input
    kwargs["batch"] = kwargs.get("batch") or 1  # batch-size 1 for tracking in videos
    kwargs["mode"] = "track"
    return self.predict(source=source, stream=stream, **kwargs)

train(trainer=None, **kwargs)

Đào tạo mô hình bằng cách sử dụng tập dữ liệu và cấu hình đào tạo được chỉ định.

Phương pháp này tạo điều kiện cho việc đào tạo mô hình với một loạt các cài đặt và cấu hình có thể tùy chỉnh. Nó hỗ trợ đào tạo với một huấn luyện viên tùy chỉnh hoặc phương pháp đào tạo mặc định được xác định trong phương pháp. Phương pháp xử lý Các tình huống khác nhau, chẳng hạn như tiếp tục đào tạo từ trạm kiểm soát, tích hợp với Ultralytics HUB, và Cập nhật mô hình và cấu hình sau khi đào tạo.

Khi sử dụng Ultralytics HUB, nếu phiên đã có mô hình được tải, phương pháp ưu tiên đào tạo HUB lập luận và đưa ra cảnh báo nếu các đối số cục bộ được cung cấp. Nó kiểm tra các bản cập nhật pip và kết hợp mặc định Cấu hình, mặc định dành riêng cho phương thức và đối số do người dùng cung cấp để đặt cấu hình quy trình đào tạo. Sau Đào tạo, nó cập nhật mô hình và cấu hình của nó, và tùy chọn đính kèm các số liệu.

Thông số:

Tên Kiểu Sự miêu tả Mặc định
trainer BaseTrainer

Một ví dụ về một lớp huấn luyện viên tùy chỉnh để đào tạo mô hình. Nếu không, các Phương pháp sử dụng một huấn luyện viên mặc định. Mặc định là Không có.

None
**kwargs any

Đối số từ khóa tùy ý đại diện cho cấu hình đào tạo. Những lập luận này là: được sử dụng để tùy chỉnh các khía cạnh khác nhau của quá trình đào tạo.

{}

Trở lại:

Kiểu Sự miêu tả
dict | None

Chỉ số đào tạo nếu có và đào tạo thành công; nếu không, Không có.

Tăng:

Kiểu Sự miêu tả
AssertionError

Nếu mô hình không phải là một PyTorch mẫu.

PermissionError

Nếu có vấn đề về quyền với phiên HUB.

ModuleNotFoundError

Nếu HUB SDK chưa được cài đặt.

Mã nguồn trong ultralytics/engine/model.py
def train(
    self,
    trainer=None,
    **kwargs,
):
    """
    Trains the model using the specified dataset and training configuration.

    This method facilitates model training with a range of customizable settings and configurations. It supports
    training with a custom trainer or the default training approach defined in the method. The method handles
    different scenarios, such as resuming training from a checkpoint, integrating with Ultralytics HUB, and
    updating model and configuration after training.

    When using Ultralytics HUB, if the session already has a loaded model, the method prioritizes HUB training
    arguments and issues a warning if local arguments are provided. It checks for pip updates and combines default
    configurations, method-specific defaults, and user-provided arguments to configure the training process. After
    training, it updates the model and its configurations, and optionally attaches metrics.

    Args:
        trainer (BaseTrainer, optional): An instance of a custom trainer class for training the model. If None, the
            method uses a default trainer. Defaults to None.
        **kwargs (any): Arbitrary keyword arguments representing the training configuration. These arguments are
            used to customize various aspects of the training process.

    Returns:
        (dict | None): Training metrics if available and training is successful; otherwise, None.

    Raises:
        AssertionError: If the model is not a PyTorch model.
        PermissionError: If there is a permission issue with the HUB session.
        ModuleNotFoundError: If the HUB SDK is not installed.
    """
    self._check_is_pytorch_model()
    if hasattr(self.session, "model") and self.session.model.id:  # Ultralytics HUB session with loaded model
        if any(kwargs):
            LOGGER.warning("WARNING ⚠️ using HUB training arguments, ignoring local training arguments.")
        kwargs = self.session.train_args  # overwrite kwargs

    checks.check_pip_update_available()

    overrides = yaml_load(checks.check_yaml(kwargs["cfg"])) if kwargs.get("cfg") else self.overrides
    custom = {
        # NOTE: handle the case when 'cfg' includes 'data'.
        "data": overrides.get("data") or DEFAULT_CFG_DICT["data"] or TASK2DATA[self.task],
        "model": self.overrides["model"],
        "task": self.task,
    }  # method defaults
    args = {**overrides, **custom, **kwargs, "mode": "train"}  # highest priority args on the right
    if args.get("resume"):
        args["resume"] = self.ckpt_path

    self.trainer = (trainer or self._smart_load("trainer"))(overrides=args, _callbacks=self.callbacks)
    if not args.get("resume"):  # manually set model only if not resuming
        self.trainer.model = self.trainer.get_model(weights=self.model if self.ckpt else None, cfg=self.model.yaml)
        self.model = self.trainer.model

        if SETTINGS["hub"] is True and not self.session:
            # Create a model in HUB
            try:
                self.session = self._get_hub_session(self.model_name)
                if self.session:
                    self.session.create_model(args)
                    # Check model was created
                    if not getattr(self.session.model, "id", None):
                        self.session = None
            except (PermissionError, ModuleNotFoundError):
                # Ignore PermissionError and ModuleNotFoundError which indicates hub-sdk not installed
                pass

    self.trainer.hub_session = self.session  # attach optional HUB session
    self.trainer.train()
    # Update model and cfg after training
    if RANK in {-1, 0}:
        ckpt = self.trainer.best if self.trainer.best.exists() else self.trainer.last
        self.model, _ = attempt_load_one_weight(ckpt)
        self.overrides = self.model.args
        self.metrics = getattr(self.trainer.validator, "metrics", None)  # TODO: no metrics returned by DDP
    return self.metrics

tune(use_ray=False, iterations=10, *args, **kwargs)

Tiến hành điều chỉnh siêu tham số cho mô hình, với tùy chọn sử dụng Ray Tune.

Phương pháp này hỗ trợ hai chế độ điều chỉnh siêu tham số: sử dụng Ray Tune hoặc phương pháp điều chỉnh tùy chỉnh. Khi Ray Tune được bật, nó sẽ tận dụng chức năng 'run_ray_tune' từ ultralyticsMô-đun .utils.tuner. Nếu không, nó sử dụng lớp 'Tuner' nội bộ để điều chỉnh. Phương pháp kết hợp mặc định, ghi đè và Đối số tùy chỉnh để cấu hình quá trình điều chỉnh.

Thông số:

Tên Kiểu Sự miêu tả Mặc định
use_ray bool

Nếu True, hãy sử dụng Ray Tune để điều chỉnh siêu tham số. Mặc định là False.

False
iterations int

Số lần lặp lại điều chỉnh để thực hiện. Mặc định là 10.

10
*args list

Danh sách đối số có độ dài thay đổi cho các đối số bổ sung.

()
**kwargs any

Đối số từ khóa tùy ý. Chúng được kết hợp với ghi đè và mặc định của mô hình.

{}

Trở lại:

Kiểu Sự miêu tả
dict

Một từ điển chứa kết quả tìm kiếm siêu tham số.

Tăng:

Kiểu Sự miêu tả
AssertionError

Nếu mô hình không phải là một PyTorch mẫu.

Mã nguồn trong ultralytics/engine/model.py
def tune(
    self,
    use_ray=False,
    iterations=10,
    *args,
    **kwargs,
):
    """
    Conducts hyperparameter tuning for the model, with an option to use Ray Tune.

    This method supports two modes of hyperparameter tuning: using Ray Tune or a custom tuning method.
    When Ray Tune is enabled, it leverages the 'run_ray_tune' function from the ultralytics.utils.tuner module.
    Otherwise, it uses the internal 'Tuner' class for tuning. The method combines default, overridden, and
    custom arguments to configure the tuning process.

    Args:
        use_ray (bool): If True, uses Ray Tune for hyperparameter tuning. Defaults to False.
        iterations (int): The number of tuning iterations to perform. Defaults to 10.
        *args (list): Variable length argument list for additional arguments.
        **kwargs (any): Arbitrary keyword arguments. These are combined with the model's overrides and defaults.

    Returns:
        (dict): A dictionary containing the results of the hyperparameter search.

    Raises:
        AssertionError: If the model is not a PyTorch model.
    """
    self._check_is_pytorch_model()
    if use_ray:
        from ultralytics.utils.tuner import run_ray_tune

        return run_ray_tune(self, max_samples=iterations, *args, **kwargs)
    else:
        from .tuner import Tuner

        custom = {}  # method defaults
        args = {**self.overrides, **custom, **kwargs, "mode": "train"}  # highest priority args on the right
        return Tuner(args=args, _callbacks=self.callbacks)(model=self, iterations=iterations)

val(validator=None, **kwargs)

Xác thực mô hình bằng cách sử dụng tập dữ liệu và cấu hình xác thực được chỉ định.

Phương pháp này tạo điều kiện thuận lợi cho quá trình xác thực mô hình, cho phép một loạt các tùy chỉnh thông qua các khác nhau Cài đặt và cấu hình. Nó hỗ trợ xác thực với trình xác thực tùy chỉnh hoặc phương pháp xác thực mặc định. Phương pháp này kết hợp các cấu hình mặc định, mặc định dành riêng cho phương thức và các đối số do người dùng cung cấp để định cấu hình quá trình xác nhận. Sau khi xác nhận, nó cập nhật các chỉ số của mô hình với kết quả thu được từ trình xác thực.

Phương thức này hỗ trợ các đối số khác nhau cho phép tùy chỉnh quá trình xác thực. Để có một toàn diện Danh sách tất cả các tùy chọn có thể định cấu hình, người dùng nên tham khảo phần 'Cấu hình' trong tài liệu.

Thông số:

Tên Kiểu Sự miêu tả Mặc định
validator BaseValidator

Một phiên bản của lớp trình xác thực tùy chỉnh để xác thực mô hình. Nếu Không có, phương thức sử dụng trình xác thực mặc định. Mặc định là Không có.

None
**kwargs any

Đối số từ khóa tùy ý đại diện cho cấu hình xác thực. Những lập luận này là: được sử dụng để tùy chỉnh các khía cạnh khác nhau của quá trình xác nhận.

{}

Trở lại:

Kiểu Sự miêu tả
dict

Số liệu xác thực thu được từ quá trình xác thực.

Tăng:

Kiểu Sự miêu tả
AssertionError

Nếu mô hình không phải là một PyTorch mẫu.

Mã nguồn trong ultralytics/engine/model.py
def val(
    self,
    validator=None,
    **kwargs,
):
    """
    Validates the model using a specified dataset and validation configuration.

    This method facilitates the model validation process, allowing for a range of customization through various
    settings and configurations. It supports validation with a custom validator or the default validation approach.
    The method combines default configurations, method-specific defaults, and user-provided arguments to configure
    the validation process. After validation, it updates the model's metrics with the results obtained from the
    validator.

    The method supports various arguments that allow customization of the validation process. For a comprehensive
    list of all configurable options, users should refer to the 'configuration' section in the documentation.

    Args:
        validator (BaseValidator, optional): An instance of a custom validator class for validating the model. If
            None, the method uses a default validator. Defaults to None.
        **kwargs (any): Arbitrary keyword arguments representing the validation configuration. These arguments are
            used to customize various aspects of the validation process.

    Returns:
        (dict): Validation metrics obtained from the validation process.

    Raises:
        AssertionError: If the model is not a PyTorch model.
    """
    custom = {"rect": True}  # method defaults
    args = {**self.overrides, **custom, **kwargs, "mode": "val"}  # highest priority args on the right

    validator = (validator or self._smart_load("validator"))(args=args, _callbacks=self.callbacks)
    validator(model=self.model)
    self.metrics = validator.metrics
    return validator.metrics





Created 2023-11-12, Updated 2024-06-02
Authors: glenn-jocher (5), Burhan-Q (1)