Saltar al contenido

Referencia para ultralytics/engine/model.py

Nota

Este archivo est√° disponible en https://github.com/ultralytics/ ultralytics/blob/main/ ultralytics/engine/model .py. Si detectas alg√ļn problema, por favor, ayuda a solucionarlo contribuyendo con una Pull Request ūüõ†ÔłŹ. ¬°Gracias ūüôŹ!



ultralytics.engine.model.Model

Bases: Module

Una clase base para implementar los modelos YOLO , unificando las API de los distintos tipos de modelos.

Esta clase proporciona una interfaz com√ļn para diversas operaciones relacionadas con los modelos YOLO , como el entrenamiento validaci√≥n, predicci√≥n, exportaci√≥n y evaluaci√≥n comparativa. Maneja distintos tipos de modelos, incluidos los cargados desde archivos locales, Ultralytics HUB o Triton Servidor. La clase est√° dise√Īada para ser flexible y ampliable para diferentes tareas y configuraciones de modelos.

Par√°metros:

Nombre Tipo Descripción Por defecto
model Union[str, Path]

Ruta o nombre del modelo a cargar o crear. Puede ser un archivo local local, un nombre de modelo de Ultralytics HUB, o un modelo de Triton Servidor. Por defecto es 'yolov8n.pt'.

'yolov8n.pt'
task Any

El tipo de tarea asociado al modelo YOLO . Puede utilizarse para especificar el dominio de aplicación del modelo, como detección de objetos, segmentación, etc. Por defecto es Ninguno.

None
verbose bool

Si es Verdadero, activa la salida verbosa durante las operaciones del modelo. Por defecto es Falso.

False

Atributos:

Nombre Tipo Descripción
callbacks dict

Un diccionario de funciones de llamada de retorno para varios eventos durante las operaciones del modelo.

predictor BasePredictor

El objeto predictor utilizado para hacer predicciones.

model Module

El modelo subyacente PyTorch .

trainer BaseTrainer

El objeto entrenador utilizado para entrenar el modelo.

ckpt dict

Los datos del punto de control si el modelo se carga desde un archivo *.pt.

cfg str

La configuración del modelo si se carga desde un archivo *.yaml.

ckpt_path str

La ruta al archivo del punto de control.

overrides dict

Un diccionario de anulaciones para la configuración del modelo.

metrics dict

Las √ļltimas m√©tricas de entrenamiento/validaci√≥n.

session HUBTrainingSession

La sesión Ultralytics HUB, si procede.

task str

El tipo de tarea al que se destina el modelo.

model_name str

El nombre del modelo.

Métodos:

Nombre Descripción
__call__

Alias del método predecir, que permite llamar a la instancia del modelo.

_new

Inicializa un nuevo modelo a partir de un archivo de configuración.

_load

Carga un modelo desde un archivo de puntos de control.

_check_is_pytorch_model

Garantiza que el modelo es un modelo PyTorch .

reset_weights

Restablece los pesos del modelo a su estado inicial.

load

Carga los pesos del modelo desde un archivo especificado.

save

Guarda el estado actual del modelo en un archivo.

info

Registra o devuelve información sobre el modelo.

fuse

Fusiona las capas Conv2d y BatchNorm2d para una inferencia optimizada.

predict

Realiza predicciones de detección de objetos.

track

Realiza el seguimiento de objetos.

val

Valida el modelo en un conjunto de datos.

benchmark

Eval√ļa el modelo en varios formatos de exportaci√≥n.

export

Exporta el modelo a distintos formatos.

train

Entrena el modelo en un conjunto de datos.

tune

Realiza el ajuste de los hiperpar√°metros.

_apply

Aplica una función a los tensores del modelo.

add_callback

A√Īade una funci√≥n de devoluci√≥n de llamada para un evento.

clear_callback

Borra todas las llamadas de retorno de un evento.

reset_callbacks

Restablece todas las retrollamadas a sus funciones por defecto.

_get_hub_session

Recupera o crea una sesión de Ultralytics HUB.

is_triton_model

Comprueba si un modelo es un modelo de servidor Triton .

is_hub_model

Comprueba si un modelo es un modelo Ultralytics HUB.

_reset_ckpt_args

Restablece los argumentos del punto de control al cargar un modelo PyTorch .

_smart_load

Carga el módulo adecuado en función de la tarea modelo.

task_map

Proporciona una correspondencia entre las tareas del modelo y las clases correspondientes.

Aumenta:

Tipo Descripción
FileNotFoundError

Si el archivo modelo especificado no existe o es inaccesible.

ValueError

Si el archivo del modelo o la configuración no son válidos o no se admiten.

ImportError

Si no est√°n instaladas las dependencias necesarias para determinados tipos de modelos (como el SDK de HUB).

TypeError

Si el modelo no es un modelo PyTorch cuando sea necesario.

AttributeError

Si los atributos o métodos necesarios no están implementados o disponibles.

NotImplementedError

Si no se admite una tarea o modo de modelo concreto.

Código fuente en ultralytics/engine/model.py
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
class Model(nn.Module):
    """
    A base class for implementing YOLO models, unifying APIs across different model types.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        from ultralytics import __version__

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        Raises:
            AttributeError: If the predictor is not properly set up.
        """
        if source is None:
            source = ASSETS
            LOGGER.warning(f"WARNING ‚ö†ÔłŹ 'source' is missing. Using 'source={source}'.")

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        checks.check_pip_update_available()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

device: torch.device property

Recupera el dispositivo en el que est√°n asignados los par√°metros del modelo.

Esta propiedad se utiliza para determinar si los parámetros del modelo están en la CPU o en la GPU. Sólo se aplica a los modelos que son instancias de nn.Módulo.

Devuelve:

Tipo Descripción
device | None

El dispositivo (CPU/GPU) del modelo si es un modelo PyTorch , en caso contrario Ninguno.

names: list property

Recupera los nombres de las clases asociadas al modelo cargado.

Esta propiedad devuelve los nombres de clase si están definidos en el modelo. Comprueba la validez de los nombres de clase utilizando la función 'check_class_names' del módulo ultralytics.nn.autobackend.

Devuelve:

Tipo Descripción
list | None

Los nombres de clase del modelo si est√°n disponibles, en caso contrario Ninguno.

task_map: dict property

Asigna la cabeza a las clases modelo, entrenador, validador y predictor.

Devuelve:

Nombre Tipo Descripción
task_map dict

El mapa de la tarea modelo a las clases de modo.

transforms property

Recupera las transformaciones aplicadas a los datos de entrada del modelo cargado.

Esta propiedad devuelve las transformaciones si est√°n definidas en el modelo.

Devuelve:

Tipo Descripción
object | None

El objeto de transformación del modelo, si está disponible; en caso contrario, Ninguno.

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

Un alias para el método predecir, que permite llamar a la instancia del modelo.

Este método simplifica el proceso de hacer predicciones permitiendo llamar directamente a la instancia del modelo con los argumentos necesarios para la predicción.

Par√°metros:

Nombre Tipo Descripción Por defecto
source str | Path | int | Image | ndarray

La fuente de la imagen para hacer predicciones. Acepta varios tipos, como rutas de archivos, URL, im√°genes PIL y matrices numpy. Por defecto es Ninguno.

None
stream bool

Si es Verdadero, trata la fuente de entrada como un flujo continuo para las predicciones. Por defecto es Falso.

False
**kwargs any

Argumentos adicionales de palabra clave para configurar el proceso de predicción.

{}

Devuelve:

Tipo Descripción
List[Results]

Una lista de resultados de predicción, encapsulada en la clase Resultados.

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

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

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

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

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

Inicializa una nueva instancia de la clase de modelo YOLO .

Este constructor configura el modelo basándose en la ruta o nombre del modelo proporcionado. Maneja varios tipos de fuentes incluyendo archivos locales, modelos Ultralytics HUB y modelos Triton Server. El método inicializa varios atributos importantes del modelo y lo prepara para operaciones como el entrenamiento, la predicción o la exportación.

Par√°metros:

Nombre Tipo Descripción Por defecto
model Union[str, Path]

La ruta o el archivo modelo a cargar o crear. Puede ser una ruta local, un nombre de modelo de Ultralytics HUB o un modelo de Triton Server. Por defecto es 'yolov8n.pt'.

'yolov8n.pt'
task Any

El tipo de tarea asociado al modelo YOLO , especificando su dominio de aplicación. Por defecto es Ninguno.

None
verbose bool

Si es Verdadero, activa la salida detallada durante la inicialización del modelo y las operaciones posteriores. posteriores. Por defecto es Falso.

False

Aumenta:

Tipo Descripción
FileNotFoundError

Si el archivo modelo especificado no existe o es inaccesible.

ValueError

Si el archivo del modelo o la configuración no son válidos o no se admiten.

ImportError

Si no est√°n instaladas las dependencias necesarias para determinados tipos de modelos (como el SDK de HUB).

Código fuente en ultralytics/engine/model.py
def __init__(
    self,
    model: Union[str, Path] = "yolov8n.pt",
    task: str = None,
    verbose: bool = False,
) -> None:
    """
    Initializes a new instance of the YOLO model class.

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

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

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

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

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

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

add_callback(event, func)

A√Īade una funci√≥n de llamada de retorno para un evento especificado.

Este método permite al usuario registrar una función de llamada de retorno personalizada que se activa en un evento específico durante entrenamiento o inferencia del modelo.

Par√°metros:

Nombre Tipo Descripción Por defecto
event str

El nombre del evento al que adjuntar la llamada de retorno.

necesario
func callable

La función de llamada de retorno que se va a registrar.

necesario

Aumenta:

Tipo Descripción
ValueError

Si no se reconoce el nombre del evento.

Código fuente en 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)

Compara el modelo en varios formatos de exportación para evaluar el rendimiento.

Este m√©todo eval√ļa el rendimiento del modelo en distintos formatos de exportaci√≥n, como ONNX, TorchScript, etc. Utiliza la funci√≥n "benchmark" del m√≥dulo ultralytics.utils.benchmarks. La evaluaci√≥n comparativa se configura mediante una combinaci√≥n de valores de configuraci√≥n por defecto, argumentos espec√≠ficos del modelo, valores por defecto espec√≠ficos del m√©todo y cualquier argumento adicional proporcionado por el usuario.

El m√©todo admite varios argumentos que permiten personalizar el proceso de evaluaci√≥n comparativa, como el conjunto de datos tama√Īo de imagen, modos de precisi√≥n, selecci√≥n de dispositivo y verbosidad. Para obtener una lista completa de todas opciones configurables, los usuarios deben consultar la secci√≥n "configuraci√≥n" de la documentaci√≥n.

Par√°metros:

Nombre Tipo Descripción Por defecto
**kwargs any

Argumentos arbitrarios de palabras clave para personalizar el proceso de evaluación comparativa. Se combinan con configuraciones por defecto, argumentos específicos del modelo y métodos por defecto.

{}

Devuelve:

Tipo Descripción
dict

Un diccionario que contiene los resultados del proceso de evaluación comparativa.

Aumenta:

Tipo Descripción
AssertionError

Si el modelo no es un modelo PyTorch .

Código fuente en ultralytics/engine/model.py
def benchmark(
    self,
    **kwargs,
):
    """
    Benchmarks the model across various export formats to evaluate performance.

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

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

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

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

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

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

clear_callback(event)

Borra todas las funciones de llamada de retorno registradas para un evento especificado.

Este método elimina todas las funciones de llamada de retorno personalizadas y por defecto asociadas al evento dado.

Par√°metros:

Nombre Tipo Descripción Por defecto
event str

El nombre del evento para el que borrar las rellamadas.

necesario

Aumenta:

Tipo Descripción
ValueError

Si no se reconoce el nombre del evento.

Código fuente en 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)

Genera incrustaciones de im√°genes bas√°ndose en la fuente proporcionada.

Este método es una envoltura del método 'predecir()', centrada en generar incrustaciones a partir de una fuente de imágenes. Permite personalizar el proceso de incrustación mediante varios argumentos de palabra clave.

Par√°metros:

Nombre Tipo Descripción Por defecto
source str | int | Image | ndarray

La fuente de la imagen para generar incrustaciones. La fuente puede ser una ruta de archivo, una URL, una imagen PIL, una matriz numpy, etc. Por defecto es Ninguno.

None
stream bool

Si es Verdadero, se transmiten las predicciones. Por defecto es Falso.

False
**kwargs any

Argumentos de palabra clave adicionales para configurar el proceso de incrustación.

{}

Devuelve:

Tipo Descripción
List[Tensor]

Una lista que contiene las im√°genes incrustadas.

Aumenta:

Tipo Descripción
AssertionError

Si el modelo no es un modelo PyTorch .

Código fuente en ultralytics/engine/model.py
def embed(
    self,
    source: Union[str, Path, int, list, tuple, np.ndarray, torch.Tensor] = None,
    stream: bool = False,
    **kwargs,
) -> list:
    """
    Generates image embeddings based on the provided source.

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

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

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

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

export(**kwargs)

Exporta el modelo a otro formato adecuado para su despliegue.

Este método facilita la exportación del modelo a varios formatos (por ejemplo, ONNX, TorchScript) para su despliegue despliegue. Utiliza la clase "Exportador" para el proceso de exportación, combinando las anulaciones específicas del modelo, el método y los argumentos adicionales que se proporcionen. Los argumentos combinados se utilizan para configurar los ajustes de exportación.

El método admite una amplia gama de argumentos para personalizar el proceso de exportación. Para obtener una lista completa de todos posibles, consulta la sección "Configuración" de la documentación.

Par√°metros:

Nombre Tipo Descripción Por defecto
**kwargs any

Argumentos arbitrarios de palabras clave para personalizar el proceso de exportación. Se combinan con las del modelo y los métodos por defecto.

{}

Devuelve:

Tipo Descripción
str

El nombre de archivo del modelo exportado en el formato especificado, o un objeto relacionado con el proceso de exportación.

Aumenta:

Tipo Descripción
AssertionError

Si el modelo no es un modelo PyTorch .

Código fuente en ultralytics/engine/model.py
def export(
    self,
    **kwargs,
) -> str:
    """
    Exports the model to a different format suitable for deployment.

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

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

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

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

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

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

fuse()

Fusiona las capas Conv2d y BatchNorm2d en el modelo.

Este método optimiza el modelo fusionando las capas Conv2d y BatchNorm2d, lo que puede mejorar la velocidad de inferencia.

Aumenta:

Tipo Descripción
AssertionError

Si el modelo no es un modelo PyTorch .

Código fuente en 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)

Registra o devuelve información sobre el modelo.

Este método proporciona una visión general o información detallada sobre el modelo, dependiendo de los argumentos pasados. Puede controlar la verbosidad de la salida.

Par√°metros:

Nombre Tipo Descripción Por defecto
detailed bool

Si es Verdadero, muestra información detallada sobre el modelo. Por defecto es Falso.

False
verbose bool

Si es True, imprime la información. Si es False, devuelve la información. Por defecto es Verdadero.

True

Devuelve:

Tipo Descripción
list

Varios tipos de información sobre el modelo, en función de los parámetros "detallado" y "detallado".

Aumenta:

Tipo Descripción
AssertionError

Si el modelo no es un modelo PyTorch .

Código fuente en 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

Comprueba si el modelo proporcionado es un modelo HUB.

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

is_triton_model(model) staticmethod

El modelo es una cadena de URL del servidor Triton , es decir :////

Código fuente en 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')

Carga en el modelo los par√°metros del archivo de pesos especificado.

Este método permite cargar ponderaciones desde un archivo o directamente desde un objeto ponderaciones. Hace coincidir los parámetros por nombre y forma y los transfiere al modelo.

Par√°metros:

Nombre Tipo Descripción Por defecto
weights str | Path

Ruta al archivo de ponderaciones o a un objeto de ponderaciones. Por defecto es 'yolov8n.pt'.

'yolov8n.pt'

Devuelve:

Nombre Tipo Descripción
self Model

La instancia de la clase con pesos cargados.

Aumenta:

Tipo Descripción
AssertionError

Si el modelo no es un modelo PyTorch .

Código fuente en 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)

Realiza predicciones sobre la fuente de imagen dada utilizando el modelo YOLO .

Este método facilita el proceso de predicción, permitiendo diversas configuraciones mediante argumentos de palabras clave. Admite predicciones con predictores personalizados o con el método de predicción por defecto. El método maneja diferentes tipos de fuentes de imágenes y puede funcionar en modo streaming. También admite modelos del tipo SAM mediante "predicciones".

El método crea un nuevo predictor si no está ya presente y actualiza sus argumentos con cada llamada. También emite una advertencia y utiliza los activos por defecto si no se proporciona la "fuente". El método determina si está siendo llamado desde la interfaz de la línea de comandos y ajusta su comportamiento en consecuencia, incluyendo el establecimiento de valores por defecto para el umbral de confianza y el comportamiento de guardado.

Par√°metros:

Nombre Tipo Descripción Por defecto
source str | int | Image | ndarray

La fuente de la imagen para hacer predicciones. Acepta varios tipos, como rutas de archivos, URLs, im√°genes PIL y matrices numpy. Por defecto es ACTIVOS.

None
stream bool

Trata la fuente de entrada como un flujo continuo para las predicciones. Por defecto es Falso.

False
predictor BasePredictor

Una instancia de una clase de predictor personalizada para hacer predicciones. Si es Ninguno, el método utiliza un predictor por defecto. Por defecto es Ninguno.

None
**kwargs any

Argumentos adicionales de palabras clave para configurar el proceso de predicción. Estos argumentos permiten una mayor personalización del comportamiento de la predicción.

{}

Devuelve:

Tipo Descripción
List[Results]

Una lista de resultados de predicción, encapsulada en la clase Resultados.

Aumenta:

Tipo Descripción
AttributeError

Si el predictor no est√° bien configurado.

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

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

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

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

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

    Raises:
        AttributeError: If the predictor is not properly set up.
    """
    if source is None:
        source = ASSETS
        LOGGER.warning(f"WARNING ‚ö†ÔłŹ 'source' is missing. Using 'source={source}'.")

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

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

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

reset_callbacks()

Restablece todas las retrollamadas a sus funciones por defecto.

Este m√©todo restablece las funciones de llamada de retorno predeterminadas para todos los eventos, eliminando cualquier llamada de retorno personalizada que se haya a√Īadidas anteriormente.

Código fuente en 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()

Restablece los parámetros del modelo a valores inicializados aleatoriamente, descartando de hecho toda la información de entrenamiento.

Este método recorre todos los módulos del modelo y restablece sus parámetros si tienen un método método 'reset_parameters'. También se asegura de que todos los parámetros tienen "requires_grad" establecido en True, lo que permite que se actualicen durante el entrenamiento. actualizarse durante el entrenamiento.

Devuelve:

Nombre Tipo Descripción
self Model

La instancia de la clase con pesos restablecidos.

Aumenta:

Tipo Descripción
AssertionError

Si el modelo no es un modelo PyTorch .

Código fuente en ultralytics/engine/model.py
def reset_weights(self) -> "Model":
    """
    Resets the model parameters to randomly initialized values, effectively discarding all training information.

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

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

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

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

Guarda el estado actual del modelo en un archivo.

Este método exporta el punto de control del modelo (ckpt) al nombre de archivo especificado.

Par√°metros:

Nombre Tipo Descripción Por defecto
filename str | Path

El nombre del archivo en el que guardar el modelo. Por defecto es 'modelo_guardado.pt'.

'saved_model.pt'
use_dill bool

Si se intenta utilizar dill para la serialización si está disponible. Por defecto es True.

True

Aumenta:

Tipo Descripción
AssertionError

Si el modelo no es un modelo PyTorch .

Código fuente en ultralytics/engine/model.py
def save(self, filename: Union[str, Path] = "saved_model.pt", use_dill=True) -> None:
    """
    Saves the current model state to a file.

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

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

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

    from ultralytics import __version__

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

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

Realiza el seguimiento de objetos en la fuente de entrada especificada utilizando los seguidores registrados.

Este método realiza el seguimiento de objetos utilizando los predictores del modelo y, opcionalmente, los rastreadores registrados. Es capaz capaz de manejar distintos tipos de fuentes de entrada, como rutas de archivos o secuencias de vídeo. El método admite personalización del proceso de seguimiento mediante varios argumentos de palabra clave. Registra los rastreadores si no están ya están presentes y, opcionalmente, los persiste basándose en la bandera "persistir".

El método establece un umbral de confianza por defecto específicamente para el seguimiento basado en ByteTrack, que requiere como entrada predicciones de baja confianza. El modo de seguimiento se establece explícitamente en los argumentos de palabra clave.

Par√°metros:

Nombre Tipo Descripción Por defecto
source str

La fuente de entrada para el seguimiento de objetos. Puede ser una ruta de archivo, una URL o un flujo de vídeo.

None
stream bool

Trata la fuente de entrada como un flujo de vídeo continuo. Por defecto es Falso.

False
persist bool

Persiste los rastreadores entre diferentes llamadas a este método. Por defecto es Falso.

False
**kwargs any

Argumentos de palabras clave adicionales para configurar el proceso de seguimiento. Estos argumentos permiten una mayor personalización del comportamiento de rastreo.

{}

Devuelve:

Tipo Descripción
List[Results]

Una lista de resultados del seguimiento, encapsulada en la clase Resultados.

Aumenta:

Tipo Descripción
AttributeError

Si el predictor no tiene seguidores registrados.

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

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

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

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

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

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

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

train(trainer=None, **kwargs)

Entrena el modelo utilizando el conjunto de datos y la configuración de entrenamiento especificados.

Este método facilita el entrenamiento del modelo con una serie de ajustes y configuraciones personalizables. Admite el entrenamiento con un entrenador personalizado o con el enfoque de entrenamiento por defecto definido en el método. El método maneja diferentes escenarios, como reanudar el entrenamiento desde un punto de control, integrarse con Ultralytics HUB, y actualizar el modelo y la configuración después del entrenamiento.

Cuando se utiliza Ultralytics HUB, si la sesión ya tiene un modelo cargado, el método da prioridad al entrenamiento HUB y emite una advertencia si se proporcionan argumentos locales. Comprueba si hay actualizaciones de pip y combina configuraciones, valores por defecto específicos del método y argumentos proporcionados por el usuario para configurar el proceso de entrenamiento. Después de entrenamiento, actualiza el modelo y sus configuraciones, y opcionalmente adjunta métricas.

Par√°metros:

Nombre Tipo Descripción Por defecto
trainer BaseTrainer

Una instancia de una clase entrenadora personalizada para entrenar el modelo. Si es Ninguno, el método utiliza un entrenador por defecto. Por defecto es Ninguno.

None
**kwargs any

Argumentos arbitrarios de palabras clave que representan la configuración de entrenamiento. Estos argumentos se utilizan para personalizar varios aspectos del proceso de entrenamiento.

{}

Devuelve:

Tipo Descripción
dict | None

Métricas de entrenamiento si están disponibles y el entrenamiento se ha realizado correctamente; en caso contrario, Ninguna.

Aumenta:

Tipo Descripción
AssertionError

Si el modelo no es un modelo PyTorch .

PermissionError

Si hay un problema de permisos en la sesión HUB.

ModuleNotFoundError

Si el SDK del HUB no est√° instalado.

Código fuente en ultralytics/engine/model.py
def train(
    self,
    trainer=None,
    **kwargs,
):
    """
    Trains the model using the specified dataset and training configuration.

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

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

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

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

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

    checks.check_pip_update_available()

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

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

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

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

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

Realiza el ajuste de los hiperparámetros del modelo, con la opción de utilizar el Ajuste de Rayos.

Este método admite dos modos de ajuste de hiperparámetros: utilizando Ray Tune o un método de ajuste personalizado. Cuando Ray Tune está activado, aprovecha la función 'run_ray_tune' del módulo ultralytics.utils.tuner. De lo contrario, utiliza la clase interna 'Tuner' para la sintonización. El método combina argumentos por defecto, anulados y argumentos personalizados para configurar el proceso de ajuste.

Par√°metros:

Nombre Tipo Descripción Por defecto
use_ray bool

Si es True, utiliza Ray Tune para el ajuste de hiperpar√°metros. Por defecto es Falso.

False
iterations int

El n√ļmero de iteraciones de ajuste a realizar. Por defecto es 10.

10
*args list

Lista de argumentos de longitud variable para argumentos adicionales.

()
**kwargs any

Argumentos arbitrarios de palabras clave. Se combinan con las anulaciones y los valores por defecto del modelo.

{}

Devuelve:

Tipo Descripción
dict

Un diccionario que contiene los resultados de la b√ļsqueda de hiperpar√°metros.

Aumenta:

Tipo Descripción
AssertionError

Si el modelo no es un modelo PyTorch .

Código fuente en ultralytics/engine/model.py
def tune(
    self,
    use_ray=False,
    iterations=10,
    *args,
    **kwargs,
):
    """
    Conducts hyperparameter tuning for the model, with an option to use Ray Tune.

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

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

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

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

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

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

val(validator=None, **kwargs)

Valida el modelo utilizando un conjunto de datos y una configuración de validación especificados.

Este método facilita el proceso de validación del modelo, permitiendo una serie de personalizaciones mediante diversos ajustes y configuraciones. Admite la validación con un validador personalizado o con el método de validación por defecto. El método combina configuraciones por defecto, valores por defecto específicos del método y argumentos proporcionados por el usuario para configurar el proceso de validación. Tras la validación, actualiza las métricas del modelo con los resultados obtenidos del validador.

El método admite varios argumentos que permiten personalizar el proceso de validación. Para obtener una lista de todas las opciones configurables, los usuarios deben consultar la sección "Configuración" de la documentación.

Par√°metros:

Nombre Tipo Descripción Por defecto
validator BaseValidator

Una instancia de una clase validadora personalizada para validar el modelo. Si Ninguno, el método utiliza un validador por defecto. Por defecto es Ninguno.

None
**kwargs any

Argumentos arbitrarios de palabra clave que representan la configuración de validación. Estos argumentos se utilizan para personalizar varios aspectos del proceso de validación.

{}

Devuelve:

Tipo Descripción
dict

Métricas de validación obtenidas en el proceso de validación.

Aumenta:

Tipo Descripción
AssertionError

Si el modelo no es un modelo PyTorch .

Código fuente en ultralytics/engine/model.py
def val(
    self,
    validator=None,
    **kwargs,
):
    """
    Validates the model using a specified dataset and validation configuration.

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

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

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

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

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

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





Creado 2023-11-12, Actualizado 2024-05-18
Autores: glenn-jocher (4), Burhan-Q (1)