انتقل إلى المحتوى

مرجع ل ultralytics/engine/model.py

ملاحظه

هذا الملف متاح في https://github.com/ultralytics/ultralytics/ نقطة / الرئيسية /ultralytics/ المحرك / الموديل .py. إذا اكتشفت مشكلة ، فيرجى المساعدة في إصلاحها من خلال المساهمة في طلب 🛠️ سحب. شكرا لك 🙏!



ultralytics.engine.model.Model

قواعد: Module

فئة أساسية للتنفيذ YOLO النماذج، وتوحيد واجهات برمجة التطبيقات عبر أنواع النماذج المختلفة.

توفر هذه الفئة واجهة مشتركة لمختلف العمليات المتعلقة ب YOLO النماذج ، مثل التدريب ، التحقق من الصحة والتنبؤ والتصدير والقياس. يتعامل مع أنواع مختلفة من النماذج ، بما في ذلك تلك محملة من الملفات المحلية ، Ultralytics HUBأو Triton ملقم. تم تصميم الفصل ليكون مرنا و قابل للتمديد لمختلف المهام وتكوينات النموذج.

البارامترات:

اسم نوع وصف افتراضي
model Union[str, Path]

مسار أو اسم النموذج المراد تحميله أو إنشائه. يمكن أن يكون هذا ملفا محليا المسار، اسم طراز من Ultralytics HUB، أو أ Triton طراز الخادم. الإعدادات الافتراضية ل 'yolov8n.pt'.

'yolov8n.pt'
task Any

نوع المهمة المقترنة ب YOLO نموذج. يمكن استخدام هذا لتحديد النموذج مجال التطبيق ، مثل اكتشاف الكائنات والتجزئة وما إلى ذلك. الإعدادات الافتراضية إلى لا شيء.

None
verbose bool

إذا كان صحيحا، يقوم بتمكين الإخراج المطول أثناء عمليات النموذج. الإعدادات الافتراضية إلى خطأ.

False

سمات:

اسم نوع وصف
callbacks dict

قاموس لوظائف رد الاتصال لمختلف الأحداث أثناء عمليات النموذج.

predictor BasePredictor

كائن المتنبئ المستخدم لعمل التنبؤات.

model Module

الأساس PyTorch نموذج.

trainer BaseTrainer

كائن المدرب المستخدم لتدريب النموذج.

ckpt dict

بيانات نقطة التفتيش إذا تم تحميل النموذج من ملف *.pt.

cfg str

تكوين النموذج إذا تم تحميله من ملف *.yaml.

ckpt_path str

المسار إلى ملف نقطة التفتيش.

overrides dict

قاموس التجاوزات لتكوين النموذج.

metrics dict

أحدث مقاييس التدريب / التحقق من الصحة.

session HUBTrainingSession

ال Ultralytics HUB الجلسة ، إن وجدت.

task str

نوع المهمة المخصصة للنموذج.

model_name str

اسم النموذج.

أساليب:

اسم وصف
__call__

الاسم المستعار لطريقة التنبؤ ، مما يتيح أن يكون مثيل النموذج قابلا للاستدعاء.

_new

تهيئة نموذج جديد استنادا إلى ملف تكوين.

_load

تحميل نموذج من ملف نقطة تفتيش.

_check_is_pytorch_model

يضمن أن النموذج هو PyTorch نموذج.

reset_weights

يعيد ضبط أوزان النموذج إلى حالتها الابتدائية.

load

تحميل أوزان النموذج من ملف محدد.

save

يحفظ الحالة الحالية للنموذج في ملف.

info

يسجل أو يرجع معلومات حول النموذج.

fuse

يدمج طبقات Conv2d و BatchNorm2d للاستدلال الأمثل.

predict

ينفذ تنبؤات الكشف عن الكائنات.

track

ينفذ تتبع الكائن.

val

التحقق من صحة النموذج على مجموعة بيانات.

benchmark

يقيس النموذج على تنسيقات التصدير المختلفة.

export

يصدر النموذج إلى تنسيقات مختلفة.

train

يدرب النموذج على مجموعة بيانات.

tune

ينفذ ضبط المعلمات الفائقة.

_apply

يطبق دالة على موترات النموذج.

add_callback

إضافة وظيفة رد اتصال لحدث.

clear_callback

مسح جميع عمليات الاسترجاعات لحدث ما.

reset_callbacks

يعيد تعيين جميع عمليات الاسترجاعات إلى وظائفها الافتراضية.

_get_hub_session

يسترجع أو ينشئ ملف Ultralytics HUB جلسة.

is_triton_model

يتحقق مما إذا كان النموذج عبارة عن Triton طراز الخادم.

is_hub_model

يتحقق مما إذا كان النموذج هو Ultralytics HUB نموذج.

_reset_ckpt_args

إعادة تعيين وسيطات نقطة التفتيش عند تحميل ملف PyTorch نموذج.

_smart_load

يقوم بتحميل الوحدة النمطية المناسبة بناء على مهمة النموذج.

task_map

يوفر تعيينا من مهام النموذج إلى الفئات المقابلة.

يثير:

نوع وصف
FileNotFoundError

إذا كان ملف النموذج المحدد غير موجود أو يتعذر الوصول إليه.

ValueError

إذا كان ملف النموذج أو التكوين غير صالح أو غير مدعوم.

ImportError

إذا كانت التبعيات مطلوبة لأنواع نماذج معينة (مثل HUB SDK) غير مثبتة.

TypeError

إذا لم يكن النموذج PyTorch نموذج عند الحاجة.

AttributeError

إذا لم يتم تنفيذ السمات أو الأساليب المطلوبة أو لم تكن متوفرة.

NotImplementedError

إذا كانت مهمة أو وضع نموذج معين غير مدعوم.

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

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

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

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

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

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

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

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

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

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

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

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

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

        self.model_name = model

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

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

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

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

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

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

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

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

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

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

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

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

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

        Args:
            weights (str): model checkpoint to be loaded
            task (str | None): model task
        """
        suffix = Path(weights).suffix
        if suffix == ".pt":
            self.model, self.ckpt = attempt_load_one_weight(weights)
            self.task = self.model.args["task"]
            self.overrides = self.model.args = self._reset_ckpt_args(self.model.args)
            self.ckpt_path = self.model.pt_path
        else:
            weights = checks.check_file(weights)
            self.model, self.ckpt = weights, None
            self.task = task or guess_model_task(weights)
            self.ckpt_path = weights
        self.overrides["model"] = weights
        self.overrides["task"] = self.task

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

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

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

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

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

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

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

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

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

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

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

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

        Args:
            filename (str | Path): The name of the file to save the model to. Defaults to 'saved_model.pt'.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        checks.check_pip_update_available()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

device: torch.device property

يسترجع الجهاز الذي يتم تخصيص معلمات النموذج عليه.

يتم استخدام هذه الخاصية لتحديد ما إذا كانت معلمات النموذج على وحدة المعالجة المركزية أو وحدة معالجة الرسومات. ينطبق فقط على النماذج التي هي مثيلات nn. الوحده النمطيه.

ارجاع:

نوع وصف
device | None

الجهاز (وحدة المعالجة المركزية / وحدة معالجة الرسومات) للطراز إذا كان PyTorch نموذج ، وإلا لا شيء.

names: list property

يسترجع أسماء الفئات المقترنة بالنموذج المحمل.

ترجع هذه الخاصية أسماء الفئات إذا تم تعريفها في النموذج. يتحقق من أسماء الفئات للتأكد من صحتها باستخدام الدالة "check_class_names" من ultralytics.nn.autobackend وحدة.

ارجاع:

نوع وصف
list | None

أسماء فئات النموذج إن وجدت ، وإلا لا شيء.

task_map: dict property

توجه الخريطة إلى فئات النموذج والمدرب والمدقق والمتنبئ.

ارجاع:

اسم نوع وصف
task_map dict

خريطة مهمة النموذج إلى فئات الوضع.

transforms property

يسترجع التحويلات المطبقة على بيانات الإدخال للنموذج المحمل.

ترجع هذه الخاصية التحويلات إذا تم تعريفها في النموذج.

ارجاع:

نوع وصف
object | None

كائن التحويل للنموذج إن وجد، وإلا لا شيء.

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

اسم مستعار لأسلوب التنبؤ ، مما يتيح أن يكون مثيل النموذج قابلا للاستدعاء.

تعمل هذه الطريقة على تبسيط عملية إجراء التنبؤات من خلال السماح باستدعاء مثيل النموذج مباشرة مع الحجج المطلوبة للتنبؤ.

البارامترات:

اسم نوع وصف افتراضي
source str | Path | int | Image | ndarray

مصدر الصورة لصنع التنبؤات. يقبل أنواعا مختلفة ، بما في ذلك مسارات الملفات وعناوين URL وصور PIL والمصفوفات الرقمية. الإعدادات الافتراضية إلى لا شيء.

None
stream bool

إذا كان صحيحا، يعامل مصدر الإدخال كدفق مستمر للتنبؤات. الإعدادات الافتراضية إلى خطأ.

False
**kwargs dict

وسيطات الكلمات الرئيسية الإضافية لتكوين عملية التنبؤ.

{}

ارجاع:

نوع وصف
List[Results]

قائمة بنتائج التنبؤ، مغلفة في فئة النتائج.

شفرة المصدر في ultralytics/engine/model.py
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164165 166167168 169
def __call__(
    self,
    source: Union[str, Path, int, list, tuple, np.ndarray, torch.Tensor] = None,
    stream: bool = False,
    **kwargs,
) -> list:
    """
    An alias for the predict method, enabling the model instance to be callable.

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

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

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

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

تهيئة مثيل جديد من YOLO فئة النموذج.

يقوم هذا المنشئ بإعداد النموذج استنادا إلى مسار النموذج أو الاسم المقدم. يتعامل مع أنواع مختلفة من النماذج المصادر ، بما في ذلك الملفات المحلية ، Ultralytics HUB النماذج، و Triton نماذج الخادم. الطريقة تهيئ عدة السمات المهمة للنموذج وإعداده لعمليات مثل التدريب أو التنبؤ أو التصدير.

البارامترات:

اسم نوع وصف افتراضي
model Union[str, Path]

ملف المسار أو النموذج المراد تحميله أو إنشائه. هذا يمكن أن يكون محليا مسار الملف، اسم نموذج من Ultralytics HUB، أو أ Triton طراز الخادم. الإعدادات الافتراضية ل 'yolov8n.pt'.

'yolov8n.pt'
task Any

نوع المهمة المقترنة ب YOLO النموذج ، مع تحديد مجال التطبيق الخاص به. الإعدادات الافتراضية إلى لا شيء.

None
verbose bool

إذا كان True ، يتيح الإخراج المطول أثناء تهيئة النموذج وما بعده العمليات. الإعدادات الافتراضية إلى خطأ.

False

يثير:

نوع وصف
FileNotFoundError

إذا كان ملف النموذج المحدد غير موجود أو يتعذر الوصول إليه.

ValueError

إذا كان ملف النموذج أو التكوين غير صالح أو غير مدعوم.

ImportError

إذا كانت التبعيات مطلوبة لأنواع نماذج معينة (مثل HUB SDK) غير مثبتة.

شفرة المصدر في ultralytics/engine/model.py
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 142143 144
def __init__(
    self,
    model: Union[str, Path] = "yolov8n.pt",
    task: str = None,
    verbose: bool = False,
) -> None:
    """
    Initializes a new instance of the YOLO model class.

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

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

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

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

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

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

    self.model_name = model

add_callback(event, func)

إضافة وظيفة رد اتصال لحدث محدد.

تسمح هذه الطريقة للمستخدم بتسجيل وظيفة رد اتصال مخصصة يتم تشغيلها في حدث معين أثناء نموذج التدريب أو الاستدلال.

البارامترات:

اسم نوع وصف افتراضي
event str

اسم الحدث المراد إرفاق رد الاتصال به.

مطلوب
func callable

وظيفة معاودة الاتصال المراد تسجيلها.

مطلوب

يثير:

نوع وصف
ValueError

إذا لم يتم التعرف على اسم الحدث.

شفرة المصدر في ultralytics/engine/model.py
740 741 742 743 744 745 746 747 748 749 750 751 752753754
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)

يقيس النموذج عبر تنسيقات التصدير المختلفة لتقييم الأداء.

تقوم هذه الطريقة بتقييم أداء النموذج في تنسيقات تصدير مختلفة ، مثل ONNX, TorchScriptالخ. يستخدم وظيفة "المعيار" من ultralytics.utils.benchmarks module. تم تكوين قياس الأداء باستخدام مجموعة من قيم التكوين الافتراضية والوسيطات الخاصة بالنموذج والافتراضيات الخاصة بالأسلوب و أي وسيطات إضافية للكلمات الرئيسية يوفرها المستخدم.

تدعم الطريقة العديد من الوسيطات التي تسمح بتخصيص عملية قياس الأداء ، مثل مجموعة البيانات الاختيار وحجم الصورة وأوضاع الدقة واختيار الجهاز والإسهاب. للحصول على قائمة شاملة للجميع خيارات قابلة للتكوين ، يجب على المستخدمين الرجوع إلى قسم "التكوين" في الوثائق.

البارامترات:

اسم نوع وصف افتراضي
**kwargs dict

وسيطات الكلمات الرئيسية التعسفية لتخصيص عملية قياس الأداء. يتم الجمع بين هذه مع التكوينات الافتراضية والوسيطات الخاصة بالنموذج والإعدادات الافتراضية للأسلوب.

{}

ارجاع:

نوع وصف
dict

قاموس يحتوي على نتائج عملية المقارنة المرجعية.

يثير:

نوع وصف
AssertionError

إذا لم يكن النموذج PyTorch نموذج.

شفرة المصدر في ultralytics/engine/model.py
507 508 509 510 511 512 513 514 515 516 517 518519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534535 536 537 538539 540 541 542 543 544 545 546
def benchmark(
    self,
    **kwargs,
):
    """
    Benchmarks the model across various export formats to evaluate performance.

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

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

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

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

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

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

clear_callback(event)

يمسح جميع وظائف رد الاتصال المسجلة لحدث محدد.

تزيل هذه الطريقة جميع وظائف رد الاتصال المخصصة والافتراضية المرتبطة بالحدث المحدد.

البارامترات:

اسم نوع وصف افتراضي
event str

اسم الحدث الذي سيتم مسح عمليات الاسترجاعات الخاصة به.

مطلوب

يثير:

نوع وصف
ValueError

إذا لم يتم التعرف على اسم الحدث.

شفرة المصدر في ultralytics/engine/model.py
756 757 758 759 760 761 762 763 764 765 766767768
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)

يولد تضمينات الصور بناء على المصدر المقدم.

هذه الطريقة عبارة عن غلاف حول طريقة "predict ()" ، مع التركيز على إنشاء عمليات تضمين من مصدر صورة. يسمح بتخصيص عملية التضمين من خلال وسيطات الكلمات الرئيسية المختلفة.

البارامترات:

اسم نوع وصف افتراضي
source str | int | Image | ndarray

مصدر الصورة لإنشاء التضمينات. يمكن أن يكون المصدر مسار ملف ، عنوان URL ، صورة PIL ، صفيف numpy ، إلخ. الإعدادات الافتراضية إلى لا شيء.

None
stream bool

إذا كان هذا صحيحا ، يتم بث التنبؤات. الإعدادات الافتراضية إلى خطأ.

False
**kwargs dict

وسيطات الكلمات الأساسية الإضافية لتكوين عملية التضمين.

{}

ارجاع:

نوع وصف
List[Tensor]

قائمة تحتوي على تضمينات الصور.

يثير:

نوع وصف
AssertionError

إذا لم يكن النموذج PyTorch نموذج.

شفرة المصدر في ultralytics/engine/model.py
345 346 347 348 349 350 351 352 353 354 355 356 357358359 360 361 362 363 364 365 366 367 368369 370 371
def embed(
    self,
    source: Union[str, Path, int, list, tuple, np.ndarray, torch.Tensor] = None,
    stream: bool = False,
    **kwargs,
) -> list:
    """
    Generates image embeddings based on the provided source.

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

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

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

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

export(**kwargs)

تصدير النموذج إلى تنسيق مختلف مناسب للنشر.

تسهل هذه الطريقة تصدير النموذج إلى تنسيقات مختلفة (على سبيل المثال ، ONNX, TorchScript) للنشر اغراض. يستخدم فئة "المصدر" لعملية التصدير ، ويجمع بين التجاوزات الخاصة بالنموذج ، والطريقة الإعدادات الافتراضية وأي وسيطات إضافية مقدمة. يتم استخدام الوسيطات المدمجة لتكوين إعدادات التصدير.

تدعم الطريقة مجموعة واسعة من الحجج لتخصيص عملية التصدير. للحصول على قائمة شاملة للجميع الوسيطات المحتملة ، راجع قسم "التكوين" في الوثائق.

البارامترات:

اسم نوع وصف افتراضي
**kwargs dict

وسيطات الكلمات الرئيسية العشوائية لتخصيص عملية التصدير. يتم الجمع بين هذه مع تجاوزات النموذج والإعدادات الافتراضية للأسلوب.

{}

ارجاع:

نوع وصف
object

النموذج المصدر بالتنسيق المحدد ، أو كائن متعلق بعملية التصدير.

يثير:

نوع وصف
AssertionError

إذا لم يكن النموذج PyTorch نموذج.

شفرة المصدر في ultralytics/engine/model.py
548 549 550 551 552 553 554 555 556 557 558559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575576 577
def export(
    self,
    **kwargs,
):
    """
    Exports the model to a different format suitable for deployment.

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

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

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

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

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

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

fuse()

يدمج طبقات Conv2d و BatchNorm2d في النموذج.

تعمل هذه الطريقة على تحسين النموذج عن طريق دمج طبقات Conv2d و BatchNorm2d ، والتي يمكن أن تحسن سرعة الاستدلال.

يثير:

نوع وصف
AssertionError

إذا لم يكن النموذج PyTorch نموذج.

شفرة المصدر في ultralytics/engine/model.py
333 334 335 336 337 338339 340 341 342343
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)

يسجل أو يعيد معلومات النموذج.

توفر هذه الطريقة نظرة عامة أو معلومات مفصلة حول النموذج ، اعتمادا على الوسيطات التي تم تمريرها. يمكنه التحكم في إسهاب الإخراج.

البارامترات:

اسم نوع وصف افتراضي
detailed bool

إذا كان True ، يعرض معلومات مفصلة حول النموذج. الإعدادات الافتراضية إلى خطأ.

False
verbose bool

إذا كان هذا صحيحا، فسيقوم بطباعة المعلومات. إذا كان خطأ، ترجع المعلومات. الإعدادات الافتراضية إلى صواب.

True

ارجاع:

نوع وصف
list

أنواع مختلفة من المعلومات حول النموذج ، اعتمادا على المعلمات "التفصيلية" و "المطولة".

يثير:

نوع وصف
AssertionError

إذا لم يكن النموذج PyTorch نموذج.

شفرة المصدر في ultralytics/engine/model.py
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328329 330331 
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

تحقق مما إذا كان النموذج المقدم هو ملف HUB نموذج.

شفرة المصدر في ultralytics/engine/model.py
187188 189 190 191 192 193 194 195196
@staticmethod
def is_hub_model(model: str) -> bool:
    """Check if the provided model is a HUB model."""
    return any(
        (
            model.startswith(f"{HUB_WEB_ROOT}/models/"),  # i.e. https://hub.ultralytics.com/models/MODEL_ID
            [len(x) for x in model.split("_")] == [42, 20],  # APIKEY_MODELID
            len(model) == 20 and not Path(model).exists() and all(x not in model for x in "./\\"),  # MODELID
        )
    )

is_triton_model(model) staticmethod

هو نموذج أ Triton سلسلة عنوان URL للخادم ، أي :////

شفرة المصدر في ultralytics/engine/model.py
179 180 181 182 183 184 185
@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')

تحميل المعلمات من ملف الأوزان المحدد إلى النموذج.

تدعم هذه الطريقة تحميل الأوزان من ملف أو مباشرة من كائن الأوزان. يطابق المعلمات بواسطة الاسم والشكل ونقلهما إلى النموذج.

البارامترات:

اسم نوع وصف افتراضي
weights str | Path

المسار إلى ملف الأوزان أو كائن الأوزان. الإعدادات الافتراضية ل 'yolov8n.pt'.

'yolov8n.pt'

ارجاع:

اسم نوع وصف
self Model

مثيل الفئة مع الأوزان المحملة.

يثير:

نوع وصف
AssertionError

إذا لم يكن النموذج PyTorch نموذج.

شفرة المصدر في ultralytics/engine/model.py
276 277 278 279 280 281 282 283 284 285 286 287288289290 291 292 293 294295 296
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)

ينفذ تنبؤات على مصدر الصورة المحدد باستخدام YOLO نموذج.

تسهل هذه الطريقة عملية التنبؤ ، مما يسمح بتكوينات مختلفة من خلال وسيطات الكلمات الرئيسية. وهو يدعم التنبؤات باستخدام المتنبئين المخصصين أو طريقة التنبؤ الافتراضية. الطريقة تتعامل مع مختلف أنواع مصادر الصور ويمكن أن تعمل في وضع البث. كما يوفر الدعم ل SAM-نوع النماذج من خلال "المطالبات".

تقوم الطريقة بإعداد متنبئ جديد إذا لم يكن موجودا بالفعل وتحديث وسيطاته مع كل مكالمة. كما أنه يصدر تحذيرا ويستخدم الأصول الافتراضية إذا لم يتم توفير "المصدر". تحدد الطريقة ما إذا كانت يتم استدعاؤه من واجهة سطر الأوامر ويضبط سلوكه وفقا لذلك ، بما في ذلك تعيين الإعدادات الافتراضية لعتبة الثقة وسلوك الادخار.

البارامترات:

اسم نوع وصف افتراضي
source str | int | Image | ndarray

مصدر الصورة لعمل التنبؤات. يقبل أنواعا مختلفة ، بما في ذلك مسارات الملفات وعناوين URL وصور PIL والمصفوفات الرقمية. الإعدادات الافتراضية للأصول.

None
stream bool

يعامل مصدر الإدخال كدفق مستمر للتنبؤات. الإعدادات الافتراضية إلى خطأ.

False
predictor BasePredictor

مثيل لفئة تنبؤ مخصصة لعمل التنبؤات. إذا لم يكن هناك شيء ، فإن الطريقة تستخدم متنبئا افتراضيا. الإعدادات الافتراضية إلى لا شيء.

None
**kwargs dict

وسيطات الكلمات الرئيسية الإضافية لتكوين عملية التنبؤ. تسمح هذه الحجج لمزيد من التخصيص لسلوك التنبؤ.

{}

ارجاع:

نوع وصف
List[Results]

قائمة بنتائج التنبؤ، مغلفة في فئة النتائج.

يثير:

نوع وصف
AttributeError

إذا لم يتم إعداد المتنبئ بشكل صحيح.

شفرة المصدر في ultralytics/engine/model.py
373 374 375 376 377 378 379 380 381 382 383 384 385 386 387388389 390 391 392 393 394 395 396397398399 400 401 402 403 404405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427428 429
def predict(
    self,
    source: Union[str, Path, int, list, tuple, np.ndarray, torch.Tensor] = None,
    stream: bool = False,
    predictor=None,
    **kwargs,
) -> list:
    """
    Performs predictions on the given image source using the YOLO model.

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

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

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

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

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

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

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

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

reset_callbacks()

يعيد تعيين جميع عمليات الاسترجاعات إلى وظائفها الافتراضية.

تعيد هذه الطريقة وظائف رد الاتصال الافتراضية لجميع الأحداث ، مع إزالة أي عمليات رد اتصال مخصصة كانت تمت إضافته مسبقا.

شفرة المصدر في ultralytics/engine/model.py
770 771 772 773 774 775 776 777 778
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()

يعيد تعيين معلمات النموذج إلى قيم تمت تهيئتها عشوائيا، مع تجاهل جميع معلومات التدريب بشكل فعال.

تتكرر هذه الطريقة من خلال جميع الوحدات النمطية في النموذج وتعيد تعيين معلماتها إذا كان لديهم ملف طريقة "reset_parameters". كما أنه يضمن تعيين "requires_grad" لجميع المعلمات على True ، مما يمكنها من ليتم تحديثها أثناء التدريب.

ارجاع:

اسم نوع وصف
self Model

مثيل الفئة مع إعادة تعيين الأوزان.

يثير:

نوع وصف
AssertionError

إذا لم يكن النموذج PyTorch نموذج.

شفرة المصدر في ultralytics/engine/model.py
254 255 256 257 258 259 260 261 262 263 264 265 266267268 269270 271 272 273 274
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')

يحفظ حالة النموذج الحالية إلى ملف.

تقوم هذه الطريقة بتصدير نقطة تفتيش النموذج (ckpt) إلى اسم الملف المحدد.

البارامترات:

اسم نوع وصف افتراضي
filename str | Path

اسم الملف لحفظ النموذج فيه. الإعدادات الافتراضية هي "saved_model.pt".

'saved_model.pt'

يثير:

نوع وصف
AssertionError

إذا لم يكن النموذج PyTorch نموذج.

شفرة المصدر في ultralytics/engine/model.py
298 299 300 301 302 303 304 305 306 307 308309310311
def save(self, filename: Union[str, Path] = "saved_model.pt") -> None:
    """
    Saves the current model state to a file.

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

    Args:
        filename (str | Path): The name of the file to save the model to. Defaults to 'saved_model.pt'.

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

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

يقوم بإجراء تتبع الكائن على مصدر الإدخال المحدد باستخدام أجهزة التتبع المسجلة.

تقوم هذه الطريقة بتتبع الكائنات باستخدام متنبئات النموذج وأجهزة التتبع المسجلة اختياريا. إنه من دواعي سروري قادرة على التعامل مع أنواع مختلفة من مصادر الإدخال مثل مسارات الملفات أو تدفقات الفيديو. تدعم الطريقة تخصيص عملية التتبع من خلال وسيطات الكلمات الرئيسية المختلفة. يسجل أجهزة التتبع إذا لم تكن كذلك موجودة بالفعل وتستمر اختياريا بناء على علامة "استمرار".

تقوم الطريقة بتعيين عتبة ثقة افتراضية خاصة للتتبع المستند إلى ByteTrack ، والذي يتطلب انخفاضا تنبؤات الثقة كمدخلات. يتم تعيين وضع التتبع بشكل صريح في وسيطات الكلمات الرئيسية.

البارامترات:

اسم نوع وصف افتراضي
source str

مصدر الإدخال لتتبع الكائنات. يمكن أن يكون مسار ملف أو عنوان URL أو دفق فيديو.

None
stream bool

يعامل مصدر الإدخال كدفق فيديو مستمر. الإعدادات الافتراضية إلى خطأ.

False
persist bool

تستمر أدوات التتبع بين المكالمات المختلفة لهذه الطريقة. الإعدادات الافتراضية إلى خطأ.

False
**kwargs dict

وسيطات الكلمات الرئيسية الإضافية لتكوين عملية التتبع. تسمح هذه الحجج لمزيد من التخصيص لسلوك التتبع.

{}

ارجاع:

نوع وصف
List[Results]

قائمة بنتائج التتبع، مغلفة في فئة النتائج.

يثير:

نوع وصف
AttributeError

إذا لم يكن لدى المتنبئ أجهزة تتبع مسجلة.

شفرة المصدر في ultralytics/engine/model.py
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448449 450 451 452 453 454455 456457458 459460 461 462 463 464 465 466 467 468
def track(
    self,
    source: Union[str, Path, int, list, tuple, np.ndarray, torch.Tensor] = None,
    stream: bool = False,
    persist: bool = False,
    **kwargs,
) -> list:
    """
    Conducts object tracking on the specified input source using the registered trackers.

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

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

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

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

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

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

train(trainer=None, **kwargs)

يدرب النموذج باستخدام مجموعة البيانات المحددة وتكوين التدريب.

تسهل هذه الطريقة تدريب النموذج مع مجموعة من الإعدادات والتكوينات القابلة للتخصيص. وهو يدعم التدريب مع مدرب مخصص أو نهج التدريب الافتراضي المحدد في الطريقة. تتعامل الطريقة مع سيناريوهات مختلفة ، مثل استئناف التدريب من نقطة تفتيش ، والتكامل مع Ultralytics HUBو تحديث النموذج والتكوين بعد التدريب.

عند استخدام Ultralytics HUB، إذا كانت الجلسة تحتوي بالفعل على نموذج محمل ، فإن الطريقة تعطي الأولوية HUB تدريب الحجج ويصدر تحذيرا إذا تم توفير الحجج المحلية. يتحقق من وجود تحديثات للنقطة ويجمع بين الإعدادات الافتراضية التكوينات والافتراضيات الخاصة بالأسلوب والوسيطات التي يوفرها المستخدم لتكوين عملية التدريب. بعد التدريب ، يقوم بتحديث النموذج وتكويناته ، وإرفاق المقاييس اختياريا.

البارامترات:

اسم نوع وصف افتراضي
trainer BaseTrainer

مثال لفئة مدرب مخصص لتدريب النموذج. إذا لم يكن هناك شيء ، فإن يستخدم الأسلوب مدربا افتراضيا. الإعدادات الافتراضية إلى لا شيء.

None
**kwargs dict

وسيطات الكلمات الرئيسية العشوائية التي تمثل تكوين التدريب. هذه الحجج هي تستخدم لتخصيص جوانب مختلفة من عملية التدريب.

{}

ارجاع:

نوع وصف
dict | None

مقاييس التدريب إذا كانت متوفرة وكان التدريب ناجحا ؛ خلاف ذلك ، لا شيء.

يثير:

نوع وصف
AssertionError

إذا لم يكن النموذج PyTorch نموذج.

PermissionError

إذا كانت هناك مشكلة في الإذن مع HUB جلسة.

ModuleNotFoundError

إذا كان HUB لم يتم تثبيت SDK.

شفرة المصدر في ultralytics/engine/model.py
579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596597598 599 600 601 602 603 604 605606607608609610611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628629 630 631 632 633 634 635636 637 638 639640 641 642 643 644 645 646 647 648649 650 651
def train(
    self,
    trainer=None,
    **kwargs,
):
    """
    Trains the model using the specified dataset and training configuration.

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

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

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

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

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

    checks.check_pip_update_available()

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

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

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

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

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

يجري ضبط المعلمات الفائقة للنموذج، مع خيار استخدام Ray Tune.

تدعم هذه الطريقة وضعين لضبط المعلمات الفائقة: استخدام Ray Tune أو طريقة ضبط مخصصة. عند تمكين Ray Tune ، فإنه يستفيد من وظيفة "run_ray_tune" من ultralyticsوحدة .utils.tuner. خلاف ذلك ، فإنه يستخدم فئة "الموالف" الداخلية للضبط. تجمع الطريقة بين الإعداد الافتراضي والتجاوز و وسيطات مخصصة لتكوين عملية الضبط.

البارامترات:

اسم نوع وصف افتراضي
use_ray bool

إذا كان صحيحا ، يستخدم Ray Tune لضبط المعلمات الفائقة. الإعدادات الافتراضية إلى خطأ.

False
iterations int

عدد تكرارات الضبط المراد تنفيذها. الإعدادات الافتراضية إلى 10.

10
*args list

قائمة وسيطات متغيرة الطول للوسيطات الإضافية.

()
**kwargs dict

وسيطات الكلمات الرئيسية التعسفية. يتم دمجها مع تجاوزات النموذج والإعدادات الافتراضية.

{}

ارجاع:

نوع وصف
dict

قاموس يحتوي على نتائج البحث عن المعلمات الفائقة.

يثير:

نوع وصف
AssertionError

إذا لم يكن النموذج PyTorch نموذج.

شفرة المصدر في ultralytics/engine/model.py
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 678679 680681 682 683 684 685 686 687 688 689690
def tune(
    self,
    use_ray=False,
    iterations=10,
    *args,
    **kwargs,
):
    """
    Conducts hyperparameter tuning for the model, with an option to use Ray Tune.

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

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

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

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

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

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

val(validator=None, **kwargs)

التحقق من صحة النموذج باستخدام مجموعة بيانات محددة وتكوين التحقق من الصحة.

تسهل هذه الطريقة عملية التحقق من صحة النموذج ، مما يسمح بمجموعة من التخصيص من خلال مختلف الإعدادات والتكوينات. وهو يدعم التحقق من الصحة باستخدام مدقق مخصص أو نهج التحقق الافتراضي. يجمع الأسلوب بين التكوينات الافتراضية والافتراضيات الخاصة بالأسلوب والوسيطات التي يوفرها المستخدم لتكوين عملية التحقق من الصحة. بعد التحقق من الصحة ، يقوم بتحديث مقاييس النموذج بالنتائج التي تم الحصول عليها من المدقق.

تدعم الطريقة العديد من الوسيطات التي تسمح بتخصيص عملية التحقق من الصحة. للحصول على شامل قائمة بجميع الخيارات القابلة للتكوين ، يجب على المستخدمين الرجوع إلى قسم "التكوين" في الوثائق.

البارامترات:

اسم نوع وصف افتراضي
validator BaseValidator

مثيل لفئة مدقق مخصص للتحقق من صحة النموذج. لو لا شيء، تستخدم الطريقة مدققا افتراضيا. الإعدادات الافتراضية إلى لا شيء.

None
**kwargs dict

وسيطات الكلمات الأساسية العشوائية التي تمثل تكوين التحقق من الصحة. هذه الحجج هي تستخدم لتخصيص جوانب مختلفة من عملية التحقق من الصحة.

{}

ارجاع:

نوع وصف
dict

مقاييس التحقق التي تم الحصول عليها من عملية التحقق من الصحة.

يثير:

نوع وصف
AssertionError

إذا لم يكن النموذج PyTorch نموذج.

شفرة المصدر في ultralytics/engine/model.py
470 471 472 473 474 475 476 477 478479 480 481 482 483 484 485 486 487 488489 490 491 492 493 494 495 496 497 498 499 500 501 502503504 505
def val(
    self,
    validator=None,
    **kwargs,
):
    """
    Validates the model using a specified dataset and validation configuration.

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

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

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

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

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

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





تم إنشاء 2023-11-12, اخر تحديث 2023-11-25
المؤلفون: جلين جوشر (3)