Zum Inhalt springen

Referenz f├╝r ultralytics/engine/model.py

Hinweis

Diese Datei ist verf├╝gbar unter https://github.com/ultralytics/ ultralytics/blob/main/ ultralytics/engine/model .py. Wenn du ein Problem entdeckst, hilf bitte mit, es zu beheben, indem du einen Pull Request ­čŤá´ŞĆ einreichst. Vielen Dank ­čÖĆ!



ultralytics.engine.model.Model

Basen: Module

Eine Basisklasse f├╝r die Implementierung von YOLO Modellen, die APIs f├╝r verschiedene Modelltypen vereinheitlicht.

Diese Klasse bietet eine gemeinsame Schnittstelle f├╝r verschiedene Vorg├Ąnge im Zusammenhang mit YOLO Modellen, wie Training, Validierung, Vorhersage, Exportieren und Benchmarking. Sie behandelt verschiedene Modelltypen, darunter solche die von lokalen Dateien, Ultralytics HUB oder Triton Server geladen werden. Die Klasse ist so konzipiert, dass sie flexibel und und f├╝r verschiedene Aufgaben und Modellkonfigurationen erweiterbar.

Parameter:

Name Typ Beschreibung Standard
model Union[str, Path]

Pfad oder Name des zu ladenden oder zu erstellenden Modells. Dies kann ein lokaler Dateipfad sein Pfad, ein Modellname von Ultralytics HUB oder ein Triton Servermodell sein. Der Standardwert ist 'yolov8n.pt'.

'yolov8n.pt'
task Any

Der Aufgabentyp, der mit dem Modell YOLO verbunden ist. Hier kann der Anwendungsbereich des Modells angegeben werden Anwendungsbereich des Modells angeben, z. B. Objekterkennung, Segmentierung usw. Der Standardwert ist Keine.

None
verbose bool

Bei True wird die ausf├╝hrliche Ausgabe w├Ąhrend der Operationen des Modells aktiviert. Der Standardwert ist False.

False

Attribute:

Name Typ Beschreibung
callbacks dict

Ein W├Ârterbuch mit Callback-Funktionen f├╝r verschiedene Ereignisse w├Ąhrend des Modellbetriebs.

predictor BasePredictor

Das Pr├Ądiktorobjekt, das f├╝r Vorhersagen verwendet wird.

model Module

Das zugrunde liegende PyTorch Modell.

trainer BaseTrainer

Das Trainerobjekt, das f├╝r das Training des Modells verwendet wird.

ckpt dict

Die Kontrollpunktdaten, wenn das Modell aus einer *.pt-Datei geladen wird.

cfg str

Die Konfiguration des Modells, wenn es aus einer *.yaml-Datei geladen wird.

ckpt_path str

Der Pfad zur Checkpoint-Datei.

overrides dict

Ein W├Ârterbuch mit ├ťberschreibungen f├╝r die Modellkonfiguration.

metrics dict

Die neuesten Trainings-/Validierungskennzahlen.

session HUBTrainingSession

Die Ultralytics HUB Sitzung, falls zutreffend.

task str

Die Art der Aufgabe, f├╝r die das Modell bestimmt ist.

model_name str

Der Name des Modells.

Methoden:

Name Beschreibung
__call__

Alias f├╝r die Vorhersagemethode, damit die Modellinstanz aufgerufen werden kann.

_new

Initialisiert ein neues Modell basierend auf einer Konfigurationsdatei.

_load

L├Ądt ein Modell aus einer Checkpoint-Datei.

_check_is_pytorch_model

Stellt sicher, dass das Modell ein PyTorch Modell ist.

reset_weights

Setzt die Gewichte des Modells auf ihren Ausgangszustand zur├╝ck.

load

L├Ądt Modellgewichte aus einer angegebenen Datei.

save

Speichert den aktuellen Zustand des Modells in einer Datei.

info

Protokolliert oder gibt Informationen ├╝ber das Modell zur├╝ck.

fuse

Verschmelzt Conv2d- und BatchNorm2d-Schichten f├╝r optimierte Inferenz.

predict

F├╝hrt Vorhersagen zur Objekterkennung durch.

track

F├╝hrt eine Objektverfolgung durch.

val

├ťberpr├╝ft das Modell anhand eines Datensatzes.

benchmark

Vergleicht das Modell mit verschiedenen Exportformaten.

export

Exportiert das Modell in verschiedene Formate.

train

Trainiert das Modell auf einem Datensatz.

tune

F├╝hrt die Abstimmung der Hyperparameter durch.

_apply

Wendet eine Funktion auf die Tensoren des Modells an.

add_callback

F├╝gt eine Callback-Funktion f├╝r ein Ereignis hinzu.

clear_callback

L├Âscht alle R├╝ckrufe f├╝r ein Ereignis.

reset_callbacks

Setzt alle R├╝ckrufe auf ihre Standardfunktionen zur├╝ck.

_get_hub_session

Ruft eine Ultralytics HUB Sitzung ab oder erstellt sie.

is_triton_model

Pr├╝ft, ob ein Modell ein Triton Server-Modell ist.

is_hub_model

Pr├╝ft, ob ein Modell ein Ultralytics HUB Modell ist.

_reset_ckpt_args

Setzt die Checkpoint-Argumente beim Laden eines PyTorch Modells zur├╝ck.

_smart_load

L├Ądt das passende Modul basierend auf der Modellaufgabe.

task_map

Stellt eine Zuordnung von Modellaufgaben zu den entsprechenden Klassen her.

Erh├Âht:

Typ Beschreibung
FileNotFoundError

Wenn die angegebene Modelldatei nicht existiert oder unzug├Ąnglich ist.

ValueError

Wenn die Modelldatei oder die Konfiguration ung├╝ltig ist oder nicht unterst├╝tzt wird.

ImportError

Wenn erforderliche Abh├Ąngigkeiten f├╝r bestimmte Modelltypen (wie HUB SDK) nicht installiert sind.

TypeError

Wenn das Modell bei Bedarf kein PyTorch Modell ist.

AttributeError

Wenn erforderliche Attribute oder Methoden nicht implementiert oder verf├╝gbar sind.

NotImplementedError

Wenn eine bestimmte Modellaufgabe oder ein Modus nicht unterst├╝tzt wird.

Quellcode in ultralytics/engine/model.py
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 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
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
        self.model_name = model = str(model).strip()  # strip spaces

        # 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.2")
            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 = model
            self.task = task
            return

        # Load or create new YOLO model
        model = checks.check_model_file_from_stem(model)  # add suffix, i.e. yolov8n -> yolov8n.pt
        if Path(model).suffix in (".yaml", ".yml"):
            self._new(model, task=task, verbose=verbose)
        else:
            self._load(model, task=task)

        self.model_name = model

    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 (dict): 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_MODELID
                len(model) == 20 and not Path(model).exists() and all(x not in model for x in "./\\"),  # MODELID
            )
        )

    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

    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
        """
        suffix = Path(weights).suffix
        if 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)
            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

    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") -> 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'.

        Raises:
            AssertionError: If the model is not a PyTorch model.
        """
        self._check_is_pytorch_model()
        torch.save(self.ckpt, filename)

    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 (dict): 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:
        """
        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 (dict): 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 = (sys.argv[0].endswith("yolo") or sys.argv[0].endswith("ultralytics")) and any(
            x in sys.argv for x in ("predict", "track", "mode=predict", "mode=track")
        )

        custom = {"conf": 0.25, "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:
        """
        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 (dict): 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["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 (dict): 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 (dict): 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,
    ):
        """
        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 (dict): Arbitrary keyword arguments to customize the export process. These are combined with the
                model's overrides and method defaults.

        Returns:
            (object): The exported model 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 (dict): 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 = {"data": DEFAULT_CFG_DICT["data"] or TASK2DATA[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 (dict): 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

        return check_class_names(self.model.names) if hasattr(self.model, "names") else None

    @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

Ruft das Ger├Ąt ab, auf dem die Parameter des Modells zugewiesen sind.

Diese Eigenschaft wird verwendet, um zu bestimmen, ob die Parameter des Modells auf der CPU oder der GPU laufen. Sie gilt nur f├╝r Modelle die Instanzen von nn.Module sind.

Retouren:

Typ Beschreibung
device | None

Das Ger├Ąt (CPU/GPU) des Modells, wenn es sich um ein PyTorch Modell handelt, ansonsten Keine.

names: list property

Ruft die Klassennamen ab, die mit dem geladenen Modell verbunden sind.

Diese Eigenschaft gibt die Klassennamen zur├╝ck, wenn sie im Modell definiert sind. Sie pr├╝ft die Klassennamen auf G├╝ltigkeit mit der Funktion "check_class_names" aus dem Modul ultralytics.nn.autobackend.

Retouren:

Typ Beschreibung
list | None

Die Klassennamen des Modells, falls vorhanden, sonst Keine.

task_map: dict property

Ordne den Kopf den Klassen Model, Trainer, Validator und Pr├Ądiktor zu.

Retouren:

Name Typ Beschreibung
task_map dict

Die Zuordnung von Modellaufgaben zu Modusklassen.

transforms property

Ruft die Transformationen ab, die auf die Eingabedaten des geladenen Modells angewendet wurden.

Diese Eigenschaft gibt die Transformationen zur├╝ck, wenn sie im Modell definiert sind.

Retouren:

Typ Beschreibung
object | None

Das Transformationsobjekt des Modells, falls vorhanden, sonst Keine.

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

Ein Alias f├╝r die Predict-Methode, mit dem die Modellinstanz aufgerufen werden kann.

Diese Methode vereinfacht den Prozess der Vorhersage, indem sie es erm├Âglicht, die Modellinstanz direkt mit den erforderlichen Argumenten f├╝r die Vorhersage.

Parameter:

Name Typ Beschreibung Standard
source str | Path | int | Image | ndarray

Die Quelle des Bildes f├╝r die Erstellung von Vorhersagen. Akzeptiert verschiedene Typen, darunter Dateipfade, URLs, PIL-Bilder und Numpy-Arrays. Der Standardwert ist None.

None
stream bool

Bei True wird die Eingangsquelle f├╝r Vorhersagen als kontinuierlicher Stream behandelt. Der Standardwert ist False.

False
**kwargs dict

Zus├Ątzliche Schl├╝sselwortargumente f├╝r die Konfiguration des Vorhersageprozesses.

{}

Retouren:

Typ Beschreibung
List[Results]

Eine Liste von Vorhersageergebnissen, die in der Klasse Results gekapselt ist.

Quellcode in 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 (dict): 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)

Initialisiert eine neue Instanz der Modellklasse YOLO .

Dieser Konstruktor richtet das Modell auf der Grundlage des angegebenen Modellpfads oder -namens ein. Er behandelt verschiedene Arten von Modell Quellen, einschlie├člich lokaler Dateien, Ultralytics HUB Modelle und Triton Servermodelle. Die Methode initialisiert mehrere wichtige Attribute des Modells und bereitet es f├╝r Operationen wie Training, Vorhersage oder Export vor.

Parameter:

Name Typ Beschreibung Standard
model Union[str, Path]

Der Pfad oder die Modelldatei, die geladen oder erstellt werden soll. Dabei kann es sich um einen lokalen Dateipfad, ein Modellname aus Ultralytics HUB oder ein Triton Servermodell sein. Der Standardwert ist 'yolov8n.pt'.

'yolov8n.pt'
task Any

Der Aufgabentyp, der mit dem Modell YOLO verbunden ist und dessen Anwendungsbereich angibt. Der Standardwert ist Keine.

None
verbose bool

Wenn True, wird die ausf├╝hrliche Ausgabe w├Ąhrend der Initialisierung des Modells und der folgenden Operationen. Der Standardwert ist False.

False

Erh├Âht:

Typ Beschreibung
FileNotFoundError

Wenn die angegebene Modelldatei nicht existiert oder unzug├Ąnglich ist.

ValueError

Wenn die Modelldatei oder die Konfiguration ung├╝ltig ist oder nicht unterst├╝tzt wird.

ImportError

Wenn erforderliche Abh├Ąngigkeiten f├╝r bestimmte Modelltypen (wie HUB SDK) nicht installiert sind.

Quellcode in 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
    self.model_name = model = str(model).strip()  # strip spaces

    # 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.2")
        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 = model
        self.task = task
        return

    # Load or create new YOLO model
    model = checks.check_model_file_from_stem(model)  # add suffix, i.e. yolov8n -> yolov8n.pt
    if Path(model).suffix in (".yaml", ".yml"):
        self._new(model, task=task, verbose=verbose)
    else:
        self._load(model, task=task)

    self.model_name = model

add_callback(event, func)

F├╝gt eine Callback-Funktion f├╝r ein bestimmtes Ereignis hinzu.

Mit dieser Methode kann der Nutzer eine benutzerdefinierte Callback-Funktion registrieren, die bei einem bestimmten Ereignis w├Ąhrend Modelltraining oder Inferenz ausgel├Âst wird.

Parameter:

Name Typ Beschreibung Standard
event str

Der Name des Ereignisses, an das der Callback angeh├Ąngt werden soll.

erforderlich
func callable

Die zu registrierende Callback-Funktion.

erforderlich

Erh├Âht:

Typ Beschreibung
ValueError

Wenn der Ereignisname nicht erkannt wird.

Quellcode in 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)

Vergleiche das Modell mit verschiedenen Exportformaten, um die Leistung zu bewerten.

Mit dieser Methode wird die Leistung des Modells in verschiedenen Exportformaten wie ONNX, TorchScript, etc. bewertet. Sie verwendet die Funktion "Benchmark" aus dem Modul ultralytics.utils.benchmarks. Das Benchmarking wird konfiguriert mit einer Kombination aus Standardkonfigurationswerten, modellspezifischen Argumenten, methodenspezifischen Vorgaben und zus├Ątzlichen vom Benutzer bereitgestellten Schl├╝sselwortargumenten.

Die Methode unterst├╝tzt verschiedene Argumente, mit denen der Benchmarking-Prozess angepasst werden kann, z. B. Auswahl, Bildgr├Â├če, Pr├Ązisionsmodi, Ger├Ąteauswahl und Ausf├╝hrlichkeit. F├╝r eine umfassende Liste aller konfigurierbaren Optionen findest du im Abschnitt "Konfiguration" in der Dokumentation.

Parameter:

Name Typ Beschreibung Standard
**kwargs dict

Beliebige Schl├╝sselwortargumente, um den Benchmarking-Prozess anzupassen. Diese werden kombiniert mit Standardkonfigurationen, modellspezifischen Argumenten und Methodenvorgaben.

{}

Retouren:

Typ Beschreibung
dict

Ein W├Ârterbuch, das die Ergebnisse des Benchmarking-Prozesses enth├Ąlt.

Erh├Âht:

Typ Beschreibung
AssertionError

Wenn es sich bei dem Modell nicht um ein PyTorch Modell handelt.

Quellcode in 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 (dict): 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)

L├Âscht alle Callback-Funktionen, die f├╝r ein bestimmtes Ereignis registriert sind.

Diese Methode entfernt alle benutzerdefinierten und Standard-Callback-Funktionen, die mit dem angegebenen Ereignis verbunden sind.

Parameter:

Name Typ Beschreibung Standard
event str

Der Name des Ereignisses, f├╝r das die R├╝ckrufe gel├Âscht werden sollen.

erforderlich

Erh├Âht:

Typ Beschreibung
ValueError

Wenn der Ereignisname nicht erkannt wird.

Quellcode in 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)

Erzeugt Bildeinbettungen auf der Grundlage der angegebenen Quelle.

Diese Methode ist ein Wrapper um die Methode "predict()" und konzentriert sich auf die Erzeugung von Einbettungen aus einer Bildquelle. Sie erm├Âglicht die Anpassung des Einbettungsprozesses durch verschiedene Schl├╝sselwortargumente.

Parameter:

Name Typ Beschreibung Standard
source str | int | Image | ndarray

Die Quelle des Bildes f├╝r die Erzeugung von Einbettungen. Die Quelle kann ein Dateipfad, eine URL, ein PIL-Bild, ein Numpy-Array usw. sein. Der Standardwert ist None.

None
stream bool

Wenn True, werden die Vorhersagen gestreamt. Der Standardwert ist False.

False
**kwargs dict

Zus├Ątzliche Schl├╝sselwortargumente zum Konfigurieren des Einbettungsprozesses.

{}

Retouren:

Typ Beschreibung
List[Tensor]

Eine Liste mit den Bildeinbettungen.

Erh├Âht:

Typ Beschreibung
AssertionError

Wenn es sich bei dem Modell nicht um ein PyTorch Modell handelt.

Quellcode in 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 (dict): 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)

Exportiert das Modell in ein anderes Format, das f├╝r den Einsatz geeignet ist.

Diese Methode erleichtert den Export des Modells in verschiedene Formate (z. B. ONNX, TorchScript) f├╝r den Einsatz Zwecke. Sie verwendet die Klasse "Exporter" f├╝r den Exportprozess und kombiniert modellspezifische ├ťberschreibungen, Methodenvorgaben Voreinstellungen und zus├Ątzliche Argumente. Die kombinierten Argumente werden verwendet, um die Exporteinstellungen zu konfigurieren.

Die Methode unterst├╝tzt eine Vielzahl von Argumenten, mit denen du den Exportprozess anpassen kannst. Eine umfassende Liste aller m├Âglichen Argumente findest du im Abschnitt "Konfiguration" in der Dokumentation.

Parameter:

Name Typ Beschreibung Standard
**kwargs dict

Beliebige Schl├╝sselwortargumente, um den Exportprozess anzupassen. Diese werden kombiniert mit den ├ťberschreibungen und Methodenvorgaben des Modells kombiniert.

{}

Retouren:

Typ Beschreibung
object

Das exportierte Modell im angegebenen Format oder ein Objekt, das mit dem Exportprozess zusammenh├Ąngt.

Erh├Âht:

Typ Beschreibung
AssertionError

Wenn es sich bei dem Modell nicht um ein PyTorch Modell handelt.

Quellcode in ultralytics/engine/model.py
def export(
    self,
    **kwargs,
):
    """
    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 (dict): Arbitrary keyword arguments to customize the export process. These are combined with the
            model's overrides and method defaults.

    Returns:
        (object): The exported model 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()

Verschmilzt Conv2d- und BatchNorm2d-Ebenen im Modell.

Diese Methode optimiert das Modell durch die Verschmelzung von Conv2d- und BatchNorm2d-Schichten, was die Schlussfolgerungsgeschwindigkeit erh├Âhen kann.

Erh├Âht:

Typ Beschreibung
AssertionError

Wenn es sich bei dem Modell nicht um ein PyTorch Modell handelt.

Quellcode in 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)

Protokolliert oder gibt Modellinformationen zur├╝ck.

Diese Methode liefert je nach den ├╝bergebenen Argumenten einen ├ťberblick oder detaillierte Informationen ├╝ber das Modell. Sie kann die Ausf├╝hrlichkeit der Ausgabe steuern.

Parameter:

Name Typ Beschreibung Standard
detailed bool

Wenn True, werden detaillierte Informationen ├╝ber das Modell angezeigt. Der Standardwert ist False.

False
verbose bool

Wenn True, werden die Informationen gedruckt. Wenn False, werden die Informationen zur├╝ckgegeben. Der Standardwert ist True.

True

Retouren:

Typ Beschreibung
list

Verschiedene Arten von Informationen ├╝ber das Modell, abh├Ąngig von den Parametern "Detailliert" und "Ausf├╝hrlich".

Erh├Âht:

Typ Beschreibung
AssertionError

Wenn es sich bei dem Modell nicht um ein PyTorch Modell handelt.

Quellcode in 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

Pr├╝fe, ob das angegebene Modell ein HUB Modell ist.

Quellcode in 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_MODELID
            len(model) == 20 and not Path(model).exists() and all(x not in model for x in "./\\"),  # MODELID
        )
    )

is_triton_model(model) staticmethod

Ist das Modell ein Triton Server URL String, d.h. :////

Quellcode in 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')

L├Ądt Parameter aus der angegebenen Gewichte-Datei in das Modell.

Diese Methode unterst├╝tzt das Laden von Gewichten aus einer Datei oder direkt aus einem Gewichtobjekt. Sie vergleicht Parameter nach Namen und Form und ├╝bertr├Ągt sie in das Modell.

Parameter:

Name Typ Beschreibung Standard
weights str | Path

Pfad zur Datei mit den Gewichten oder einem Objekt mit Gewichten. Der Standardwert ist 'yolov8n.pt'.

'yolov8n.pt'

Retouren:

Name Typ Beschreibung
self Model

Die Instanz der Klasse mit den geladenen Gewichten.

Erh├Âht:

Typ Beschreibung
AssertionError

Wenn es sich bei dem Modell nicht um ein PyTorch Modell handelt.

Quellcode in 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)

F├╝hrt Vorhersagen f├╝r die angegebene Bildquelle anhand des Modells YOLO durch.

Diese Methode erleichtert den Vorhersageprozess und erm├Âglicht verschiedene Konfigurationen durch Schl├╝sselwortargumente. Sie unterst├╝tzt Vorhersagen mit benutzerdefinierten Pr├Ądiktoren oder der Standardpr├Ądiktormethode. Die Methode verarbeitet verschiedene Arten von Bildquellen und kann im Streaming-Modus arbeiten. Sie bietet auch Unterst├╝tzung f├╝r Modelle des Typs SAM durch "Prompts".

Die Methode richtet einen neuen Pr├Ądiktor ein, wenn er noch nicht vorhanden ist, und aktualisiert seine Argumente bei jedem Aufruf. Au├čerdem gibt sie eine Warnung aus und verwendet Standardwerte, wenn die "Quelle" nicht angegeben wird. Die Methode stellt fest, ob sie von der Befehlszeilenschnittstelle aus aufgerufen wird und passt ihr Verhalten entsprechend an, einschlie├člich der Voreinstellungen f├╝r die Vertrauensschwelle und das Speicherverhalten.

Parameter:

Name Typ Beschreibung Standard
source str | int | Image | ndarray

Die Quelle des Bildes f├╝r die Vorhersage. Akzeptiert verschiedene Typen, darunter Dateipfade, URLs, PIL-Bilder und Numpy-Arrays. Der Standardwert ist ASSETS.

None
stream bool

Behandelt die Eingabequelle als kontinuierlichen Stream f├╝r Vorhersagen. Der Standardwert ist False.

False
predictor BasePredictor

Eine Instanz einer benutzerdefinierten Pr├Ądikatorenklasse f├╝r die Erstellung von Vorhersagen. Wenn keine, verwendet die Methode einen Standardpr├Ądiktor. Der Standardwert ist None.

None
**kwargs dict

Zus├Ątzliche Schl├╝sselwortargumente zur Konfiguration des Vorhersageprozesses. Diese Argumente erm├Âglichen weitere Anpassungen des Vorhersageverhaltens.

{}

Retouren:

Typ Beschreibung
List[Results]

Eine Liste von Vorhersageergebnissen, die in der Klasse Results gekapselt ist.

Erh├Âht:

Typ Beschreibung
AttributeError

Wenn der Pr├Ądiktor nicht richtig eingestellt ist.

Quellcode in 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:
    """
    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 (dict): 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 = (sys.argv[0].endswith("yolo") or sys.argv[0].endswith("ultralytics")) and any(
        x in sys.argv for x in ("predict", "track", "mode=predict", "mode=track")
    )

    custom = {"conf": 0.25, "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()

Setzt alle R├╝ckrufe auf ihre Standardfunktionen zur├╝ck.

Diese Methode setzt die Standard-Callback-Funktionen f├╝r alle Ereignisse wieder ein und entfernt alle benutzerdefinierten Callbacks, die zuvor hinzugef├╝gt wurden. die zuvor hinzugef├╝gt wurden.

Quellcode in 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()

Setzt die Modellparameter auf zuf├Ąllige Werte zur├╝ck und verwirft damit alle Trainingsinformationen.

Diese Methode durchl├Ąuft alle Module des Modells und setzt ihre Parameter zur├╝ck, wenn sie ├╝ber eine 'reset_parameters' Methode haben. Sie stellt au├čerdem sicher, dass bei allen Parametern "requires_grad" auf True gesetzt ist, damit sie w├Ąhrend des Trainings aktualisiert werden k├Ânnen.

Retouren:

Name Typ Beschreibung
self Model

Die Instanz der Klasse mit zur├╝ckgesetzten Gewichten.

Erh├Âht:

Typ Beschreibung
AssertionError

Wenn es sich bei dem Modell nicht um ein PyTorch Modell handelt.

Quellcode in 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')

Speichert den aktuellen Modellstatus in einer Datei.

Diese Methode exportiert den Checkpoint (ckpt) des Modells in den angegebenen Dateinamen.

Parameter:

Name Typ Beschreibung Standard
filename str | Path

Der Name der Datei, in der das Modell gespeichert wird. Der Standardwert ist "saved_model.pt".

'saved_model.pt'

Erh├Âht:

Typ Beschreibung
AssertionError

Wenn es sich bei dem Modell nicht um ein PyTorch Modell handelt.

Quellcode in ultralytics/engine/model.py
def save(self, filename: Union[str, Path] = "saved_model.pt") -> 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'.

    Raises:
        AssertionError: If the model is not a PyTorch model.
    """
    self._check_is_pytorch_model()
    torch.save(self.ckpt, filename)

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

F├╝hrt die Objektverfolgung f├╝r die angegebene Eingangsquelle mit den registrierten Trackern durch.

Diese Methode f├╝hrt die Objektverfolgung mithilfe der Pr├Ądiktoren des Modells und optional registrierter Tracker durch. Sie ist Sie kann verschiedene Arten von Eingabequellen wie Dateipfade oder Videostreams verarbeiten. Die Methode unterst├╝tzt die Anpassung des Verfolgungsprozesses durch verschiedene Schl├╝sselwortargumente. Sie registriert Tracker, wenn sie noch nicht vorhanden sind, und h├Ąlt sie optional mit dem Flag "persist" fest.

Die Methode setzt eine Standard-Konfidenzschwelle speziell f├╝r das ByteTrack-basierte Tracking, das niedrige Vertrauensvorhersagen als Eingabe ben├Âtigt. Der Tracking-Modus wird explizit in den Schl├╝sselwortargumenten festgelegt.

Parameter:

Name Typ Beschreibung Standard
source str

Die Eingabequelle f├╝r die Objektverfolgung. Das kann ein Dateipfad, eine URL oder ein Videostream sein.

None
stream bool

Behandelt die Eingangsquelle als kontinuierlichen Videostrom. Der Standardwert ist False.

False
persist bool

L├Ąsst die Tracker zwischen verschiedenen Aufrufen dieser Methode bestehen. Der Standardwert ist False.

False
**kwargs dict

Zus├Ątzliche Schl├╝sselwortargumente f├╝r die Konfiguration des Tracking-Prozesses. Diese Argumente erm├Âglichen weitere Anpassungen des Tracking-Verhaltens.

{}

Retouren:

Typ Beschreibung
List[Results]

Eine Liste von Tracking-Ergebnissen, gekapselt in der Klasse Results.

Erh├Âht:

Typ Beschreibung
AttributeError

Wenn der Pr├Ądiktor keine registrierten Tracker hat.

Quellcode in 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:
    """
    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 (dict): 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["mode"] = "track"
    return self.predict(source=source, stream=stream, **kwargs)

train(trainer=None, **kwargs)

Trainiert das Modell anhand des angegebenen Datensatzes und der Trainingskonfiguration.

Diese Methode erleichtert das Modelltraining mit einer Reihe von anpassbaren Einstellungen und Konfigurationen. Sie unterst├╝tzt Training mit einem benutzerdefinierten Trainer oder dem in der Methode definierten Standard-Trainingsansatz. Die Methode behandelt verschiedene Szenarien, wie z. B. die Wiederaufnahme des Trainings von einem Kontrollpunkt aus, die Integration mit Ultralytics HUB und die Aktualisierung von Modell und Konfiguration nach dem Training.

Bei der Verwendung von Ultralytics HUB , wenn die Sitzung bereits ein geladenes Modell hat, priorisiert die Methode die HUB Trainings Argumente und gibt eine Warnung aus, wenn lokale Argumente angegeben werden. Sie pr├╝ft auf Pip-Updates und kombiniert Standard Konfigurationen, methodenspezifische Standardwerte und vom Benutzer angegebene Argumente, um den Trainingsprozess zu konfigurieren. Nach Training werden das Modell und seine Konfigurationen aktualisiert und optional Metriken hinzugef├╝gt.

Parameter:

Name Typ Beschreibung Standard
trainer BaseTrainer

Eine Instanz einer benutzerdefinierten Trainerklasse f├╝r das Training des Modells. Wenn keine, verwendet die Methode einen Standardtrainer. Der Standardwert ist None.

None
**kwargs dict

Beliebige Schl├╝sselwortargumente, die die Trainingskonfiguration darstellen. Diese Argumente werden verwendet, um verschiedene Aspekte des Trainingsprozesses anzupassen.

{}

Retouren:

Typ Beschreibung
dict | None

Ausbildungskennzahlen, falls vorhanden und die Ausbildung erfolgreich war; andernfalls Keine.

Erh├Âht:

Typ Beschreibung
AssertionError

Wenn es sich bei dem Modell nicht um ein PyTorch Modell handelt.

PermissionError

Wenn es ein Problem mit der Berechtigung f├╝r die HUB Sitzung gibt.

ModuleNotFoundError

Wenn das HUB SDK nicht installiert ist.

Quellcode in 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 (dict): 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 = {"data": DEFAULT_CFG_DICT["data"] or TASK2DATA[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)

F├╝hrt die Abstimmung der Hyperparameter f├╝r das Modell durch, mit der Option, Ray Tune zu verwenden.

Diese Methode unterst├╝tzt zwei Arten der Abstimmung von Hyperparametern: Ray Tune oder eine eigene Abstimmungsmethode. Wenn Ray Tune aktiviert ist, nutzt sie die Funktion "run_ray_tune" aus dem Modul ultralytics.utils.tuner. Andernfalls wird die interne Klasse "Tuner" zur Abstimmung verwendet. Die Methode kombiniert Standard-, ├╝berschriebene und benutzerdefinierte Argumente, um den Abstimmungsprozess zu konfigurieren.

Parameter:

Name Typ Beschreibung Standard
use_ray bool

Wenn True, wird Ray Tune f├╝r die Abstimmung der Hyperparameter verwendet. Der Standardwert ist False.

False
iterations int

Die Anzahl der durchzuf├╝hrenden Abstimmungswiederholungen. Der Standardwert ist 10.

10
*args list

Argumentliste mit variabler L├Ąnge f├╝r zus├Ątzliche Argumente.

()
**kwargs dict

Beliebige Schl├╝sselwortargumente. Diese werden mit den ├ťberschreibungen und Standardwerten des Modells kombiniert.

{}

Retouren:

Typ Beschreibung
dict

Ein W├Ârterbuch, das die Ergebnisse der Hyperparametersuche enth├Ąlt.

Erh├Âht:

Typ Beschreibung
AssertionError

Wenn es sich bei dem Modell nicht um ein PyTorch Modell handelt.

Quellcode in 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 (dict): 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)

Validiert das Modell anhand eines angegebenen Datensatzes und einer Validierungskonfiguration.

Diese Methode erleichtert den Prozess der Modellvalidierung und erm├Âglicht eine Reihe von Anpassungen durch verschiedene Einstellungen und Konfigurationen. Sie unterst├╝tzt die Validierung mit einem benutzerdefinierten Validator oder dem Standard-Validierungsansatz. Die Methode kombiniert Standardkonfigurationen, methodenspezifische Vorgaben und vom Benutzer bereitgestellte Argumente, um den den Validierungsprozess zu konfigurieren. Nach der Validierung aktualisiert sie die Metriken des Modells mit den Ergebnissen des Validierer.

Die Methode unterst├╝tzt verschiedene Argumente, mit denen der Validierungsprozess angepasst werden kann. F├╝r eine umfassende Liste aller konfigurierbaren Optionen findest du im Abschnitt "Konfiguration" in der Dokumentation.

Parameter:

Name Typ Beschreibung Standard
validator BaseValidator

Eine Instanz einer benutzerdefinierten Validator-Klasse zur Validierung des Modells. Wenn Keine, verwendet die Methode einen Standard-Validator. Der Standardwert ist None.

None
**kwargs dict

Beliebige Schl├╝sselwortargumente, die die Validierungskonfiguration darstellen. Diese Argumente werden verwendet, um verschiedene Aspekte des Validierungsprozesses anzupassen.

{}

Retouren:

Typ Beschreibung
dict

Validierungskennzahlen aus dem Validierungsprozess.

Erh├Âht:

Typ Beschreibung
AssertionError

Wenn es sich bei dem Modell nicht um ein PyTorch Modell handelt.

Quellcode in 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 (dict): 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





Erstellt am 2023-11-12, Aktualisiert am 2023-11-25
Autoren: glenn-jocher (3)