Update docs predict, buttons, reference (#6585)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
This commit is contained in:
Glenn Jocher 2023-11-25 17:59:01 +01:00 committed by GitHub
parent a1ccdb00ed
commit e361194d7f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
141 changed files with 1044 additions and 828 deletions

View file

@ -40,35 +40,35 @@ This comprehensive guide aims to give you an overview and practical insights int
Train mode is used for training a YOLOv8 model on a custom dataset. In this mode, the model is trained using the specified dataset and hyperparameters. The training process involves optimizing the model's parameters so that it can accurately predict the classes and locations of objects in an image.
[Train Examples](train.md){ .md-button .md-button--primary}
[Train Examples](train.md){ .md-button }
## [Val](val.md)
Val mode is used for validating a YOLOv8 model after it has been trained. In this mode, the model is evaluated on a validation set to measure its accuracy and generalization performance. This mode can be used to tune the hyperparameters of the model to improve its performance.
[Val Examples](val.md){ .md-button .md-button--primary}
[Val Examples](val.md){ .md-button }
## [Predict](predict.md)
Predict mode is used for making predictions using a trained YOLOv8 model on new images or videos. In this mode, the model is loaded from a checkpoint file, and the user can provide images or videos to perform inference. The model predicts the classes and locations of objects in the input images or videos.
[Predict Examples](predict.md){ .md-button .md-button--primary}
[Predict Examples](predict.md){ .md-button }
## [Export](export.md)
Export mode is used for exporting a YOLOv8 model to a format that can be used for deployment. In this mode, the model is converted to a format that can be used by other software applications or hardware devices. This mode is useful when deploying the model to production environments.
[Export Examples](export.md){ .md-button .md-button--primary}
[Export Examples](export.md){ .md-button }
## [Track](track.md)
Track mode is used for tracking objects in real-time using a YOLOv8 model. In this mode, the model is loaded from a checkpoint file, and the user can provide a live video stream to perform real-time object tracking. This mode is useful for applications such as surveillance systems or self-driving cars.
[Track Examples](track.md){ .md-button .md-button--primary}
[Track Examples](track.md){ .md-button }
## [Benchmark](benchmark.md)
Benchmark mode is used to profile the speed and accuracy of various export formats for YOLOv8. The benchmarks provide information on the size of the exported format, its `mAP50-95` metrics (for object detection, segmentation and pose)
or `accuracy_top5` metrics (for classification), and the inference time in milliseconds per image across various export formats like ONNX, OpenVINO, TensorRT and others. This information can help users choose the optimal export format for their specific use case based on their requirements for speed and accuracy.
[Benchmark Examples](benchmark.md){ .md-button .md-button--primary}
[Benchmark Examples](benchmark.md){ .md-button }

View file

@ -339,33 +339,38 @@ Below are code examples for using each source type:
model.predict('bus.jpg', save=True, imgsz=320, conf=0.5)
```
All supported arguments:
Inference arguments:
| Name | Type | Default | Description |
|-----------------|----------------|------------------------|--------------------------------------------------------------------------------|
| `source` | `str` | `'ultralytics/assets'` | source directory for images or videos |
| `conf` | `float` | `0.25` | object confidence threshold for detection |
| `iou` | `float` | `0.7` | intersection over union (IoU) threshold for NMS |
| `imgsz` | `int or tuple` | `640` | image size as scalar or (h, w) list, i.e. (640, 480) |
| `half` | `bool` | `False` | use half precision (FP16) |
| `device` | `None or str` | `None` | device to run on, i.e. cuda device=0/1/2/3 or device=cpu |
| `show` | `bool` | `False` | show results if possible |
| `save` | `bool` | `False` | save images with results |
| `save_txt` | `bool` | `False` | save results as .txt file |
| `save_conf` | `bool` | `False` | save results with confidence scores |
| `save_crop` | `bool` | `False` | save cropped images with results |
| `hide_labels` | `bool` | `False` | hide labels |
| `hide_conf` | `bool` | `False` | hide confidence scores |
| `max_det` | `int` | `300` | maximum number of detections per image |
| `vid_stride` | `bool` | `False` | video frame-rate stride |
| `stream_buffer` | `bool` | `False` | buffer all streaming frames (True) or return the most recent frame (False) |
| `line_width` | `None or int` | `None` | The line width of the bounding boxes. If None, it is scaled to the image size. |
| `visualize` | `bool` | `False` | visualize model features |
| `augment` | `bool` | `False` | apply image augmentation to prediction sources |
| `agnostic_nms` | `bool` | `False` | class-agnostic NMS |
| `retina_masks` | `bool` | `False` | use high-resolution segmentation masks |
| `classes` | `None or list` | `None` | filter results by class, i.e. classes=0, or classes=[0,2,3] |
| `boxes` | `bool` | `True` | Show boxes in segmentation predictions |
| Name | Type | Default | Description |
|-----------------|----------------|------------------------|----------------------------------------------------------------------------|
| `source` | `str` | `'ultralytics/assets'` | source directory for images or videos |
| `conf` | `float` | `0.25` | object confidence threshold for detection |
| `iou` | `float` | `0.7` | intersection over union (IoU) threshold for NMS |
| `imgsz` | `int or tuple` | `640` | image size as scalar or (h, w) list, i.e. (640, 480) |
| `half` | `bool` | `False` | use half precision (FP16) |
| `device` | `None or str` | `None` | device to run on, i.e. cuda device=0/1/2/3 or device=cpu |
| `max_det` | `int` | `300` | maximum number of detections per image |
| `vid_stride` | `bool` | `False` | video frame-rate stride |
| `stream_buffer` | `bool` | `False` | buffer all streaming frames (True) or return the most recent frame (False) |
| `visualize` | `bool` | `False` | visualize model features |
| `augment` | `bool` | `False` | apply image augmentation to prediction sources |
| `agnostic_nms` | `bool` | `False` | class-agnostic NMS |
| `retina_masks` | `bool` | `False` | use high-resolution segmentation masks |
| `classes` | `None or list` | `None` | filter results by class, i.e. classes=0, or classes=[0,2,3] |
Visualization arguments:
| Name | Type | Default | Description |
|---------------|---------------|---------|-----------------------------------------------------------------|
| `show` | `bool` | `False` | show predicted images and videos if environment allows |
| `save` | `bool` | `False` | save predicted images and videos |
| `save_txt` | `bool` | `False` | save results as `.txt` file |
| `save_conf` | `bool` | `False` | save results with confidence scores |
| `save_crop` | `bool` | `False` | save cropped images with results |
| `show_labels` | `bool` | `True` | show prediction labels, i.e. 'person' |
| `show_conf` | `bool` | `True` | show prediction confidence, i.e. '0.99' |
| `show_boxes` | `bool` | `True` | show prediction boxes |
| `line_width` | `None or int` | `None` | line width of the bounding boxes. Scaled to image size if None. |
## Image and Video Formats

View file

@ -223,6 +223,7 @@ Training settings for YOLO models refer to the various hyperparameters and confi
| `mask_ratio` | `4` | mask downsample ratio (segment train only) |
| `dropout` | `0.0` | use dropout regularization (classify train only) |
| `val` | `True` | validate/test during training |
| `plots` | `False` | save plots and images during train/val |
## Logging

View file

@ -80,7 +80,6 @@ Validation settings for YOLO models refer to the various hyperparameters and con
| `half` | `True` | use half precision (FP16) |
| `device` | `None` | device to run on, i.e. cuda device=0/1/2/3 or device=cpu |
| `dnn` | `False` | use OpenCV DNN for ONNX inference |
| `plots` | `False` | show plots during training |
| `plots` | `False` | save plots and images during train/val |
| `rect` | `False` | rectangular val with each batch collated for minimum padding |
| `split` | `val` | dataset split to use for validation, i.e. 'val', 'test' or 'train' |
|

View file

@ -205,7 +205,7 @@ The Ultralytics command line interface (CLI) allows for simple single-line comma
- `yolo predict model=yolov8n.pt, imgsz=640, conf=0.25` ❌ (do not use `,`)
- `yolo predict --model yolov8n.pt --imgsz 640 --conf 0.25` ❌ (do not use `--`)
[CLI Guide](usage/cli.md){ .md-button .md-button--primary}
[CLI Guide](usage/cli.md){ .md-button }
## Use Ultralytics with Python

View file

@ -9,50 +9,52 @@ keywords: Ultralytics, YOLO, Configuration, cfg2dict, handle_deprecation, merge_
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/__init__.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/__init__.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/cfg/__init__.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.cfg.cfg2dict
<br><br>
---
## ::: ultralytics.cfg.get_cfg
<br><br>
---
## ::: ultralytics.cfg.get_save_dir
<br><br>
---
## ::: ultralytics.cfg._handle_deprecation
<br><br>
---
## ::: ultralytics.cfg.check_dict_alignment
<br><br>
---
## ::: ultralytics.cfg.merge_equals_args
<br><br>
---
## ::: ultralytics.cfg.handle_yolo_hub
<br><br>
---
## ::: ultralytics.cfg.handle_yolo_settings
<br><br>
---
## ::: ultralytics.cfg.parse_key_value_pair
<br><br>
---
## ::: ultralytics.cfg.smart_value
<br><br>
---
## ::: ultralytics.cfg.entrypoint
<br><br>
---
## ::: ultralytics.cfg.copy_default_cfg
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, Auto-Annotate, Machine Learning, AI, Annotation, Data Pro
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/annotator.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/annotator.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/annotator.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.data.annotator.auto_annotate
<br><br>
## ::: ultralytics.data.annotator.auto_annotate
<br><br>

View file

@ -9,78 +9,80 @@ keywords: Ultralytics, Data Augmentation, BaseTransform, MixUp, RandomHSV, Lette
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/augment.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/augment.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/augment.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.data.augment.BaseTransform
<br><br>
---
## ::: ultralytics.data.augment.Compose
<br><br>
---
## ::: ultralytics.data.augment.BaseMixTransform
<br><br>
---
## ::: ultralytics.data.augment.Mosaic
<br><br>
---
## ::: ultralytics.data.augment.MixUp
<br><br>
---
## ::: ultralytics.data.augment.RandomPerspective
<br><br>
---
## ::: ultralytics.data.augment.RandomHSV
<br><br>
---
## ::: ultralytics.data.augment.RandomFlip
<br><br>
---
## ::: ultralytics.data.augment.LetterBox
<br><br>
---
## ::: ultralytics.data.augment.CopyPaste
<br><br>
---
## ::: ultralytics.data.augment.Albumentations
<br><br>
---
## ::: ultralytics.data.augment.Format
<br><br>
---
## ::: ultralytics.data.augment.ClassifyLetterBox
<br><br>
---
## ::: ultralytics.data.augment.CenterCrop
<br><br>
---
## ::: ultralytics.data.augment.ToTensor
<br><br>
---
## ::: ultralytics.data.augment.v8_transforms
<br><br>
---
## ::: ultralytics.data.augment.classify_transforms
<br><br>
---
## ::: ultralytics.data.augment.hsv2colorjitter
<br><br>
---
## ::: ultralytics.data.augment.classify_albumentations
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, docs, BaseDataset, data manipulation, dataset creation
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/base.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/base.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/base.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.data.base.BaseDataset
<br><br>
## ::: ultralytics.data.base.BaseDataset
<br><br>

View file

@ -9,30 +9,32 @@ keywords: Ultralytics, YOLO v3, Data build, DataLoader, InfiniteDataLoader, seed
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/build.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/build.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/build.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.data.build.InfiniteDataLoader
<br><br>
---
## ::: ultralytics.data.build._RepeatSampler
<br><br>
---
## ::: ultralytics.data.build.seed_worker
<br><br>
---
## ::: ultralytics.data.build.build_yolo_dataset
<br><br>
---
## ::: ultralytics.data.build.build_dataloader
<br><br>
---
## ::: ultralytics.data.build.check_source
<br><br>
---
## ::: ultralytics.data.build.load_inference_source
<br><br>

View file

@ -9,26 +9,28 @@ keywords: Ultralytics, Data Converter, coco91_to_coco80_class, merge_multi_segme
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/converter.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/converter.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/converter.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.data.converter.coco91_to_coco80_class
<br><br>
---
## ::: ultralytics.data.converter.coco80_to_coco91_class
<br><br>
---
## ::: ultralytics.data.converter.convert_coco
<br><br>
---
## ::: ultralytics.data.converter.convert_dota_to_yolo_obb
<br><br>
---
## ::: ultralytics.data.converter.min_index
<br><br>
---
## ::: ultralytics.data.converter.merge_multi_segment
<br><br>

View file

@ -9,22 +9,24 @@ keywords: Ultralytics, YOLO, YOLODataset, SemanticDataset, data handling, data m
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/dataset.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/dataset.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/dataset.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.data.dataset.YOLODataset
<br><br>
---
## ::: ultralytics.data.dataset.ClassificationDataset
<br><br>
---
## ::: ultralytics.data.dataset.SemanticDataset
<br><br>
---
## ::: ultralytics.data.dataset.load_dataset_cache_file
<br><br>
---
## ::: ultralytics.data.dataset.save_dataset_cache_file
<br><br>

View file

@ -9,34 +9,36 @@ keywords: Ultralytics, data loaders, LoadStreams, LoadImages, LoadTensor, YOLO,
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/loaders.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/loaders.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/loaders.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.data.loaders.SourceTypes
<br><br>
---
## ::: ultralytics.data.loaders.LoadStreams
<br><br>
---
## ::: ultralytics.data.loaders.LoadScreenshots
<br><br>
---
## ::: ultralytics.data.loaders.LoadImages
<br><br>
---
## ::: ultralytics.data.loaders.LoadPilAndNumpy
<br><br>
---
## ::: ultralytics.data.loaders.LoadTensor
<br><br>
---
## ::: ultralytics.data.loaders.autocast_list
<br><br>
---
## ::: ultralytics.data.loaders.get_best_youtube_url
<br><br>

View file

@ -9,58 +9,60 @@ keywords: Ultralytics, data utils, YOLO, img2label_paths, exif_size, polygon2mas
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/utils.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/utils.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.data.utils.HUBDatasetStats
<br><br>
---
## ::: ultralytics.data.utils.img2label_paths
<br><br>
---
## ::: ultralytics.data.utils.get_hash
<br><br>
---
## ::: ultralytics.data.utils.exif_size
<br><br>
---
## ::: ultralytics.data.utils.verify_image
<br><br>
---
## ::: ultralytics.data.utils.verify_image_label
<br><br>
---
## ::: ultralytics.data.utils.polygon2mask
<br><br>
---
## ::: ultralytics.data.utils.polygons2masks
<br><br>
---
## ::: ultralytics.data.utils.polygons2masks_overlap
<br><br>
---
## ::: ultralytics.data.utils.find_dataset_yaml
<br><br>
---
## ::: ultralytics.data.utils.check_det_dataset
<br><br>
---
## ::: ultralytics.data.utils.check_cls_dataset
<br><br>
---
## ::: ultralytics.data.utils.compress_one_image
<br><br>
---
## ::: ultralytics.data.utils.autosplit
<br><br>

View file

@ -9,22 +9,24 @@ keywords: Ultralytics, Exporter, IOSDetectModel, Export Formats, Try export
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/exporter.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/exporter.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/engine/exporter.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.engine.exporter.Exporter
<br><br>
---
## ::: ultralytics.engine.exporter.IOSDetectModel
<br><br>
---
## ::: ultralytics.engine.exporter.export_formats
<br><br>
---
## ::: ultralytics.engine.exporter.gd_outputs
<br><br>
---
## ::: ultralytics.engine.exporter.try_export
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, YOLO, engine model, documentation, guide, implementation,
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/model.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/model.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/engine/model.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.engine.model.Model
<br><br>
## ::: ultralytics.engine.model.Model
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, BasePredictor, YOLO, prediction, engine
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/predictor.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/predictor.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/engine/predictor.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.engine.predictor.BasePredictor
<br><br>
## ::: ultralytics.engine.predictor.BasePredictor
<br><br>

View file

@ -9,26 +9,28 @@ keywords: Ultralytics, engine, results, base tensor, boxes, keypoints
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/results.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/results.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/engine/results.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.engine.results.BaseTensor
<br><br>
---
## ::: ultralytics.engine.results.Results
<br><br>
---
## ::: ultralytics.engine.results.Boxes
<br><br>
---
## ::: ultralytics.engine.results.Masks
<br><br>
---
## ::: ultralytics.engine.results.Keypoints
<br><br>
---
## ::: ultralytics.engine.results.Probs
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, BaseTrainer, Machine Learning, Training Control, Python l
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/trainer.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/trainer.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/engine/trainer.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.engine.trainer.BaseTrainer
<br><br>
## ::: ultralytics.engine.trainer.BaseTrainer
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, Tuner, YOLO, hyperparameter tuning, optimization, object
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/tuner.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/tuner.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/engine/tuner.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.engine.tuner.Tuner
<br><br>
## ::: ultralytics.engine.tuner.Tuner
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, BaseValidator, Ultralytics engine, module, components
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/validator.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/validator.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/engine/validator.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.engine.validator.BaseValidator
<br><br>
## ::: ultralytics.engine.validator.BaseValidator
<br><br>

View file

@ -9,30 +9,32 @@ keywords: Ultralytics, hub functions, model export, dataset check, reset model,
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/__init__.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/__init__.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/hub/__init__.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.hub.login
<br><br>
---
## ::: ultralytics.hub.logout
<br><br>
---
## ::: ultralytics.hub.reset_model
<br><br>
---
## ::: ultralytics.hub.export_fmts_hub
<br><br>
---
## ::: ultralytics.hub.export_model
<br><br>
---
## ::: ultralytics.hub.get_export
<br><br>
---
## ::: ultralytics.hub.check_dataset
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, Auth, API documentation, User Authentication, AI, Machine
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/auth.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/auth.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/hub/auth.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.hub.auth.Auth
<br><br>
## ::: ultralytics.hub.auth.Auth
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, HUBTrainingSession, Documentation, Model Training, AI, Ma
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/session.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/session.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/hub/session.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.hub.session.HUBTrainingSession
<br><br>
## ::: ultralytics.hub.session.HUBTrainingSession
<br><br>

View file

@ -9,18 +9,20 @@ keywords: Ultralytics, Events, request_with_credentials, smart_request, Ultralyt
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/utils.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/hub/utils.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.hub.utils.Events
<br><br>
---
## ::: ultralytics.hub.utils.request_with_credentials
<br><br>
---
## ::: ultralytics.hub.utils.requests_with_progress
<br><br>
---
## ::: ultralytics.hub.utils.smart_request
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, FastSAM model, Model documentation, Efficient model train
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/model.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/model.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/fastsam/model.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.fastsam.model.FastSAM
<br><br>
## ::: ultralytics.models.fastsam.model.FastSAM
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, FastSAMPredictor, predictive modeling, AI optimization, m
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/predict.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/fastsam/predict.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.fastsam.predict.FastSAMPredictor
<br><br>
## ::: ultralytics.models.fastsam.predict.FastSAMPredictor
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, FastSAMPrompt, machine learning, model, guide, documentat
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/prompt.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/prompt.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/fastsam/prompt.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.fastsam.prompt.FastSAMPrompt
<br><br>
## ::: ultralytics.models.fastsam.prompt.FastSAMPrompt
<br><br>

View file

@ -9,10 +9,12 @@ keywords: Ultralytics, bounding boxes, Bboxes, image borders, object detection,
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/utils.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/fastsam/utils.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.fastsam.utils.adjust_bboxes_to_image_border
<br><br>
---
## ::: ultralytics.models.fastsam.utils.bbox_iou
## ::: ultralytics.models.fastsam.utils.adjust_bboxes_to_image_border
<br><br>
## ::: ultralytics.models.fastsam.utils.bbox_iou
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, FastSAMValidator, model, synthetic, AI, machine learning,
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/val.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/fastsam/val.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.fastsam.val.FastSAMValidator
<br><br>
## ::: ultralytics.models.fastsam.val.FastSAMValidator
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, NAS model, NAS guide, machine learning, model documentati
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/nas/model.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/nas/model.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/nas/model.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.nas.model.NAS
<br><br>
## ::: ultralytics.models.nas.model.NAS
<br><br>

View file

@ -9,6 +9,8 @@ keywords: NASPredictor, Ultralytics, Ultralytics model, model architecture, effi
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/nas/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/nas/predict.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/nas/predict.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.nas.predict.NASPredictor
<br><br>
## ::: ultralytics.models.nas.predict.NASPredictor
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, NASValidator, models.nas.val.NASValidator, AI models, all
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/nas/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/nas/val.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/nas/val.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.nas.val.NASValidator
<br><br>
## ::: ultralytics.models.nas.val.NASValidator
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, RTDETR model, Ultralytics models, object detection, Ultra
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/model.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/model.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/rtdetr/model.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.rtdetr.model.RTDETR
<br><br>
## ::: ultralytics.models.rtdetr.model.RTDETR
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, RTDETRPredictor, model documentation, guide, real-time ob
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/predict.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/rtdetr/predict.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.rtdetr.predict.RTDETRPredictor
<br><br>
## ::: ultralytics.models.rtdetr.predict.RTDETRPredictor
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, RTDETRTrainer, model training, Ultralytics models, PyTorc
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/train.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/train.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/rtdetr/train.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.rtdetr.train.RTDETRTrainer
<br><br>
## ::: ultralytics.models.rtdetr.train.RTDETRTrainer
<br><br>

View file

@ -9,10 +9,12 @@ keywords: Ultralytics, RTDETRDataset, RTDETRValidator, real-time object detectio
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/val.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/rtdetr/val.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.rtdetr.val.RTDETRDataset
<br><br>
---
## ::: ultralytics.models.rtdetr.val.RTDETRValidator
## ::: ultralytics.models.rtdetr.val.RTDETRDataset
<br><br>
## ::: ultralytics.models.rtdetr.val.RTDETRValidator
<br><br>

View file

@ -9,46 +9,48 @@ keywords: Ultralytics, Mask Data, Transformation, Encoding, RLE encoding, Image
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/amg.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/amg.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/amg.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.models.sam.amg.is_box_near_crop_edge
<br><br>
---
## ::: ultralytics.models.sam.amg.batch_iterator
<br><br>
---
## ::: ultralytics.models.sam.amg.calculate_stability_score
<br><br>
---
## ::: ultralytics.models.sam.amg.build_point_grid
<br><br>
---
## ::: ultralytics.models.sam.amg.build_all_layer_point_grids
<br><br>
---
## ::: ultralytics.models.sam.amg.generate_crop_boxes
<br><br>
---
## ::: ultralytics.models.sam.amg.uncrop_boxes_xyxy
<br><br>
---
## ::: ultralytics.models.sam.amg.uncrop_points
<br><br>
---
## ::: ultralytics.models.sam.amg.uncrop_masks
<br><br>
---
## ::: ultralytics.models.sam.amg.remove_small_regions
<br><br>
---
## ::: ultralytics.models.sam.amg.batched_mask_to_box
<br><br>

View file

@ -9,26 +9,28 @@ keywords: Ultralytics, SAM, build sam, vision transformer, vits, build_sam_vit_l
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/build.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/build.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/build.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.models.sam.build.build_sam_vit_h
<br><br>
---
## ::: ultralytics.models.sam.build.build_sam_vit_l
<br><br>
---
## ::: ultralytics.models.sam.build.build_sam_vit_b
<br><br>
---
## ::: ultralytics.models.sam.build.build_mobile_sam
<br><br>
---
## ::: ultralytics.models.sam.build._build_sam
<br><br>
---
## ::: ultralytics.models.sam.build.build_sam
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, YOLO, SAM Model, Documentations, Machine Learning, AI, Co
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/model.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/model.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/model.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.sam.model.SAM
<br><br>
## ::: ultralytics.models.sam.model.SAM
<br><br>

View file

@ -9,10 +9,12 @@ keywords: Ultralytics, MaskDecoder, SAM modules, decoders, MLP, YOLO, machine le
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/decoders.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/decoders.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/modules/decoders.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.sam.modules.decoders.MaskDecoder
<br><br>
---
## ::: ultralytics.models.sam.modules.decoders.MLP
## ::: ultralytics.models.sam.modules.decoders.MaskDecoder
<br><br>
## ::: ultralytics.models.sam.modules.decoders.MLP
<br><br>

View file

@ -9,42 +9,44 @@ keywords: Ultralytics, Encoders, Modules, Documentation, ImageEncoderViT, Positi
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/encoders.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/encoders.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/modules/encoders.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.models.sam.modules.encoders.ImageEncoderViT
<br><br>
---
## ::: ultralytics.models.sam.modules.encoders.PromptEncoder
<br><br>
---
## ::: ultralytics.models.sam.modules.encoders.PositionEmbeddingRandom
<br><br>
---
## ::: ultralytics.models.sam.modules.encoders.Block
<br><br>
---
## ::: ultralytics.models.sam.modules.encoders.Attention
<br><br>
---
## ::: ultralytics.models.sam.modules.encoders.PatchEmbed
<br><br>
---
## ::: ultralytics.models.sam.modules.encoders.window_partition
<br><br>
---
## ::: ultralytics.models.sam.modules.encoders.window_unpartition
<br><br>
---
## ::: ultralytics.models.sam.modules.encoders.get_rel_pos
<br><br>
---
## ::: ultralytics.models.sam.modules.encoders.add_decomposed_rel_pos
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, Sam module, deep learning, model training, Ultralytics do
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/sam.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/sam.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/modules/sam.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.sam.modules.sam.Sam
<br><br>
## ::: ultralytics.models.sam.modules.sam.Sam
<br><br>

View file

@ -9,46 +9,48 @@ keywords: Ultralytics, Tiny Encoder, Conv2d_BN, MBConv, ConvLayer, Attention, Ba
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/tiny_encoder.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/tiny_encoder.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/modules/tiny_encoder.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.Conv2d_BN
<br><br>
---
## ::: ultralytics.models.sam.modules.tiny_encoder.PatchEmbed
<br><br>
---
## ::: ultralytics.models.sam.modules.tiny_encoder.MBConv
<br><br>
---
## ::: ultralytics.models.sam.modules.tiny_encoder.PatchMerging
<br><br>
---
## ::: ultralytics.models.sam.modules.tiny_encoder.ConvLayer
<br><br>
---
## ::: ultralytics.models.sam.modules.tiny_encoder.Mlp
<br><br>
---
## ::: ultralytics.models.sam.modules.tiny_encoder.Attention
<br><br>
---
## ::: ultralytics.models.sam.modules.tiny_encoder.TinyViTBlock
<br><br>
---
## ::: ultralytics.models.sam.modules.tiny_encoder.BasicLayer
<br><br>
---
## ::: ultralytics.models.sam.modules.tiny_encoder.LayerNorm2d
<br><br>
---
## ::: ultralytics.models.sam.modules.tiny_encoder.TinyViT
<br><br>

View file

@ -9,14 +9,16 @@ keywords: Ultralytics, TwoWayTransformer, Attention, AI models, transformers
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/transformer.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/transformer.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/modules/transformer.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.models.sam.modules.transformer.TwoWayTransformer
<br><br>
---
## ::: ultralytics.models.sam.modules.transformer.TwoWayAttentionBlock
<br><br>
---
## ::: ultralytics.models.sam.modules.transformer.Attention
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, predictor, models, sam.predict.Predictor, AI, machine lea
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/predict.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/predict.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.sam.predict.Predictor
<br><br>
## ::: ultralytics.models.sam.predict.Predictor
<br><br>

View file

@ -9,10 +9,12 @@ keywords: Ultralytics, YOLO, Documentation, DETRLoss, Detection Loss, Loss funct
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/utils/loss.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/utils/loss.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/utils/loss.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.utils.loss.DETRLoss
<br><br>
---
## ::: ultralytics.models.utils.loss.RTDETRDetectionLoss
## ::: ultralytics.models.utils.loss.DETRLoss
<br><br>
## ::: ultralytics.models.utils.loss.RTDETRDetectionLoss
<br><br>

View file

@ -9,10 +9,12 @@ keywords: Ultralytics, YOLO, HungarianMatcher, inverse_sigmoid, detection models
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/utils/ops.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/utils/ops.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/utils/ops.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.utils.ops.HungarianMatcher
<br><br>
---
## ::: ultralytics.models.utils.ops.get_cdn_group
## ::: ultralytics.models.utils.ops.HungarianMatcher
<br><br>
## ::: ultralytics.models.utils.ops.get_cdn_group
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, classification predictor, predict, YOLO, AI models, model
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/classify/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/classify/predict.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/classify/predict.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.yolo.classify.predict.ClassificationPredictor
<br><br>
## ::: ultralytics.models.yolo.classify.predict.ClassificationPredictor
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, YOLO, Classification Trainer, deep learning, training pro
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/classify/train.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/classify/train.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/classify/train.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.yolo.classify.train.ClassificationTrainer
<br><br>
## ::: ultralytics.models.yolo.classify.train.ClassificationTrainer
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, YOLO, ClassificationValidator, model validation, model fi
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/classify/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/classify/val.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/classify/val.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.yolo.classify.val.ClassificationValidator
<br><br>
## ::: ultralytics.models.yolo.classify.val.ClassificationValidator
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, YOLO, DetectionPredictor, detect, predict, object detecti
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/detect/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/detect/predict.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/detect/predict.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.yolo.detect.predict.DetectionPredictor
<br><br>
## ::: ultralytics.models.yolo.detect.predict.DetectionPredictor
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics YOLO, YOLO, Detection Trainer, Model Training, Machine Lea
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/detect/train.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/detect/train.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/detect/train.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.yolo.detect.train.DetectionTrainer
<br><br>
## ::: ultralytics.models.yolo.detect.train.DetectionTrainer
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, YOLO, Detection Validator, model valuation, precision, re
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/detect/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/detect/val.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/detect/val.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.yolo.detect.val.DetectionValidator
<br><br>
## ::: ultralytics.models.yolo.detect.val.DetectionValidator
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics YOLO, YOLO, YOLO model, Model Training, Machine Learning,
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/model.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/model.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/model.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.yolo.model.YOLO
<br><br>
## ::: ultralytics.models.yolo.model.YOLO
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, YOLO, PosePredictor, machine learning, AI, predictive mod
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/pose/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/pose/predict.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/pose/predict.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.yolo.pose.predict.PosePredictor
<br><br>
## ::: ultralytics.models.yolo.pose.predict.PosePredictor
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, YOLO, PoseTrainer, pose training, AI modeling, custom dat
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/pose/train.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/pose/train.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/pose/train.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.yolo.pose.train.PoseTrainer
<br><br>
## ::: ultralytics.models.yolo.pose.train.PoseTrainer
<br><br>

View file

@ -9,6 +9,8 @@ keywords: PoseValidator, Ultralytics, YOLO, Object detection, Pose validation
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/pose/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/pose/val.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/pose/val.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.yolo.pose.val.PoseValidator
<br><br>
## ::: ultralytics.models.yolo.pose.val.PoseValidator
<br><br>

View file

@ -9,6 +9,8 @@ keywords: YOLO, Ultralytics, object detection, segmentation predictor
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/segment/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/segment/predict.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/segment/predict.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.yolo.segment.predict.SegmentationPredictor
<br><br>
## ::: ultralytics.models.yolo.segment.predict.SegmentationPredictor
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, YOLO, SegmentationTrainer, image segmentation, object det
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/segment/train.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/segment/train.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/segment/train.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.yolo.segment.train.SegmentationTrainer
<br><br>
## ::: ultralytics.models.yolo.segment.train.SegmentationTrainer
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, YOLO, SegmentationValidator, model segmentation, image cl
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/segment/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/segment/val.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/segment/val.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.models.yolo.segment.val.SegmentationValidator
<br><br>
## ::: ultralytics.models.yolo.segment.val.SegmentationValidator
<br><br>

View file

@ -9,10 +9,12 @@ keywords: Ultralytics, AutoBackend, check_class_names, YOLO, YOLO models, optimi
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/autobackend.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/autobackend.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/nn/autobackend.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.nn.autobackend.AutoBackend
<br><br>
---
## ::: ultralytics.nn.autobackend.check_class_names
## ::: ultralytics.nn.autobackend.AutoBackend
<br><br>
## ::: ultralytics.nn.autobackend.check_class_names
<br><br>

View file

@ -9,70 +9,72 @@ keywords: YOLO, Ultralytics, neural network, nn.modules.block, Proto, HGBlock, S
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/block.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/block.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/nn/modules/block.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.nn.modules.block.DFL
<br><br>
---
## ::: ultralytics.nn.modules.block.Proto
<br><br>
---
## ::: ultralytics.nn.modules.block.HGStem
<br><br>
---
## ::: ultralytics.nn.modules.block.HGBlock
<br><br>
---
## ::: ultralytics.nn.modules.block.SPP
<br><br>
---
## ::: ultralytics.nn.modules.block.SPPF
<br><br>
---
## ::: ultralytics.nn.modules.block.C1
<br><br>
---
## ::: ultralytics.nn.modules.block.C2
<br><br>
---
## ::: ultralytics.nn.modules.block.C2f
<br><br>
---
## ::: ultralytics.nn.modules.block.C3
<br><br>
---
## ::: ultralytics.nn.modules.block.C3x
<br><br>
---
## ::: ultralytics.nn.modules.block.RepC3
<br><br>
---
## ::: ultralytics.nn.modules.block.C3TR
<br><br>
---
## ::: ultralytics.nn.modules.block.C3Ghost
<br><br>
---
## ::: ultralytics.nn.modules.block.GhostBottleneck
<br><br>
---
## ::: ultralytics.nn.modules.block.Bottleneck
<br><br>
---
## ::: ultralytics.nn.modules.block.BottleneckCSP
<br><br>

View file

@ -9,58 +9,60 @@ keywords: Ultralytics, Convolution Modules, Conv2, DWConv, ConvTranspose, GhostC
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/conv.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/conv.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/nn/modules/conv.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.nn.modules.conv.Conv
<br><br>
---
## ::: ultralytics.nn.modules.conv.Conv2
<br><br>
---
## ::: ultralytics.nn.modules.conv.LightConv
<br><br>
---
## ::: ultralytics.nn.modules.conv.DWConv
<br><br>
---
## ::: ultralytics.nn.modules.conv.DWConvTranspose2d
<br><br>
---
## ::: ultralytics.nn.modules.conv.ConvTranspose
<br><br>
---
## ::: ultralytics.nn.modules.conv.Focus
<br><br>
---
## ::: ultralytics.nn.modules.conv.GhostConv
<br><br>
---
## ::: ultralytics.nn.modules.conv.RepConv
<br><br>
---
## ::: ultralytics.nn.modules.conv.ChannelAttention
<br><br>
---
## ::: ultralytics.nn.modules.conv.SpatialAttention
<br><br>
---
## ::: ultralytics.nn.modules.conv.CBAM
<br><br>
---
## ::: ultralytics.nn.modules.conv.Concat
<br><br>
---
## ::: ultralytics.nn.modules.conv.autopad
<br><br>

View file

@ -9,22 +9,24 @@ keywords: Ultralytics, YOLO, Detection, Pose, RTDETRDecoder, nn modules, guides
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/head.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/head.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/nn/modules/head.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.nn.modules.head.Detect
<br><br>
---
## ::: ultralytics.nn.modules.head.Segment
<br><br>
---
## ::: ultralytics.nn.modules.head.Pose
<br><br>
---
## ::: ultralytics.nn.modules.head.Classify
<br><br>
---
## ::: ultralytics.nn.modules.head.RTDETRDecoder
<br><br>

View file

@ -9,42 +9,44 @@ keywords: Ultralytics, Ultralytics documentation, TransformerEncoderLayer, Trans
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/transformer.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/transformer.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/nn/modules/transformer.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.nn.modules.transformer.TransformerEncoderLayer
<br><br>
---
## ::: ultralytics.nn.modules.transformer.AIFI
<br><br>
---
## ::: ultralytics.nn.modules.transformer.TransformerLayer
<br><br>
---
## ::: ultralytics.nn.modules.transformer.TransformerBlock
<br><br>
---
## ::: ultralytics.nn.modules.transformer.MLPBlock
<br><br>
---
## ::: ultralytics.nn.modules.transformer.MLP
<br><br>
---
## ::: ultralytics.nn.modules.transformer.LayerNorm2d
<br><br>
---
## ::: ultralytics.nn.modules.transformer.MSDeformAttn
<br><br>
---
## ::: ultralytics.nn.modules.transformer.DeformableTransformerDecoderLayer
<br><br>
---
## ::: ultralytics.nn.modules.transformer.DeformableTransformerDecoder
<br><br>

View file

@ -9,22 +9,24 @@ keywords: Ultralytics, neural network, nn.modules.utils, bias_init_with_prob, in
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/utils.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/nn/modules/utils.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.nn.modules.utils._get_clones
<br><br>
---
## ::: ultralytics.nn.modules.utils.bias_init_with_prob
<br><br>
---
## ::: ultralytics.nn.modules.utils.linear_init_
<br><br>
---
## ::: ultralytics.nn.modules.utils.inverse_sigmoid
<br><br>
---
## ::: ultralytics.nn.modules.utils.multi_scale_deformable_attn_pytorch
<br><br>

View file

@ -9,62 +9,64 @@ keywords: Ultralytics, YOLO, nn tasks, DetectionModel, PoseModel, RTDETRDetectio
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/tasks.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/tasks.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/nn/tasks.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.nn.tasks.BaseModel
<br><br>
---
## ::: ultralytics.nn.tasks.DetectionModel
<br><br>
---
## ::: ultralytics.nn.tasks.SegmentationModel
<br><br>
---
## ::: ultralytics.nn.tasks.PoseModel
<br><br>
---
## ::: ultralytics.nn.tasks.ClassificationModel
<br><br>
---
## ::: ultralytics.nn.tasks.RTDETRDetectionModel
<br><br>
---
## ::: ultralytics.nn.tasks.Ensemble
<br><br>
---
## ::: ultralytics.nn.tasks.temporary_modules
<br><br>
---
## ::: ultralytics.nn.tasks.torch_safe_load
<br><br>
---
## ::: ultralytics.nn.tasks.attempt_load_weights
<br><br>
---
## ::: ultralytics.nn.tasks.attempt_load_one_weight
<br><br>
---
## ::: ultralytics.nn.tasks.parse_model
<br><br>
---
## ::: ultralytics.nn.tasks.yaml_model_load
<br><br>
---
## ::: ultralytics.nn.tasks.guess_model_scale
<br><br>
---
## ::: ultralytics.nn.tasks.guess_model_task
<br><br>

View file

@ -9,10 +9,12 @@ keywords: Ultralytics, TrackState, BaseTrack, Ultralytics tracker, Ultralytics d
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/basetrack.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/basetrack.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/trackers/basetrack.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.trackers.basetrack.TrackState
<br><br>
---
## ::: ultralytics.trackers.basetrack.BaseTrack
## ::: ultralytics.trackers.basetrack.TrackState
<br><br>
## ::: ultralytics.trackers.basetrack.BaseTrack
<br><br>

View file

@ -9,10 +9,12 @@ keywords: Ultralytics, BOTSORT, BOTrack, tracking system, official documentation
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/bot_sort.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/bot_sort.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/trackers/bot_sort.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.trackers.bot_sort.BOTrack
<br><br>
---
## ::: ultralytics.trackers.bot_sort.BOTSORT
## ::: ultralytics.trackers.bot_sort.BOTrack
<br><br>
## ::: ultralytics.trackers.bot_sort.BOTSORT
<br><br>

View file

@ -9,10 +9,12 @@ keywords: STrack, Ultralytics, BYTETracker, documentation, Ultralytics tracker,
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/byte_tracker.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/byte_tracker.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/trackers/byte_tracker.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.trackers.byte_tracker.STrack
<br><br>
---
## ::: ultralytics.trackers.byte_tracker.BYTETracker
## ::: ultralytics.trackers.byte_tracker.STrack
<br><br>
## ::: ultralytics.trackers.byte_tracker.BYTETracker
<br><br>

View file

@ -9,14 +9,16 @@ keywords: Ultralytics, YOLO, on predict start, register tracker, prediction func
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/track.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/track.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/trackers/track.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.trackers.track.on_predict_start
<br><br>
---
## ::: ultralytics.trackers.track.on_predict_postprocess_end
<br><br>
---
## ::: ultralytics.trackers.track.register_tracker
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, GMC utility, Ultralytics documentation, Ultralytics track
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/utils/gmc.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/utils/gmc.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/trackers/utils/gmc.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.trackers.utils.gmc.GMC
<br><br>
## ::: ultralytics.trackers.utils.gmc.GMC
<br><br>

View file

@ -9,10 +9,12 @@ keywords: Ultralytics, KalmanFilterXYAH, tracker, documentation, guide
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/utils/kalman_filter.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/utils/kalman_filter.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/trackers/utils/kalman_filter.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.trackers.utils.kalman_filter.KalmanFilterXYAH
<br><br>
---
## ::: ultralytics.trackers.utils.kalman_filter.KalmanFilterXYWH
## ::: ultralytics.trackers.utils.kalman_filter.KalmanFilterXYAH
<br><br>
## ::: ultralytics.trackers.utils.kalman_filter.KalmanFilterXYWH
<br><br>

View file

@ -9,18 +9,20 @@ keywords: Ultralytics, Trackers Utils, Matching, merge_matches, linear_assignmen
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/utils/matching.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/utils/matching.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/trackers/utils/matching.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.trackers.utils.matching.linear_assignment
<br><br>
---
## ::: ultralytics.trackers.utils.matching.iou_distance
<br><br>
---
## ::: ultralytics.trackers.utils.matching.embedding_distance
<br><br>
---
## ::: ultralytics.trackers.utils.matching.fuse_score
<br><br>

View file

@ -9,146 +9,148 @@ keywords: Ultralytics, Utils, utilitarian functions, colorstr, yaml_save, set_lo
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/__init__.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/__init__.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/__init__.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.utils.TQDM
<br><br>
---
## ::: ultralytics.utils.SimpleClass
<br><br>
---
## ::: ultralytics.utils.IterableSimpleNamespace
<br><br>
---
## ::: ultralytics.utils.ThreadingLocked
<br><br>
---
## ::: ultralytics.utils.TryExcept
<br><br>
---
## ::: ultralytics.utils.SettingsManager
<br><br>
---
## ::: ultralytics.utils.plt_settings
<br><br>
---
## ::: ultralytics.utils.set_logging
<br><br>
---
## ::: ultralytics.utils.emojis
<br><br>
---
## ::: ultralytics.utils.yaml_save
<br><br>
---
## ::: ultralytics.utils.yaml_load
<br><br>
---
## ::: ultralytics.utils.yaml_print
<br><br>
---
## ::: ultralytics.utils.is_ubuntu
<br><br>
---
## ::: ultralytics.utils.is_colab
<br><br>
---
## ::: ultralytics.utils.is_kaggle
<br><br>
---
## ::: ultralytics.utils.is_jupyter
<br><br>
---
## ::: ultralytics.utils.is_docker
<br><br>
---
## ::: ultralytics.utils.is_online
<br><br>
---
## ::: ultralytics.utils.is_pip_package
<br><br>
---
## ::: ultralytics.utils.is_dir_writeable
<br><br>
---
## ::: ultralytics.utils.is_pytest_running
<br><br>
---
## ::: ultralytics.utils.is_github_action_running
<br><br>
---
## ::: ultralytics.utils.is_git_dir
<br><br>
---
## ::: ultralytics.utils.get_git_dir
<br><br>
---
## ::: ultralytics.utils.get_git_origin_url
<br><br>
---
## ::: ultralytics.utils.get_git_branch
<br><br>
---
## ::: ultralytics.utils.get_default_args
<br><br>
---
## ::: ultralytics.utils.get_ubuntu_version
<br><br>
---
## ::: ultralytics.utils.get_user_config_dir
<br><br>
---
## ::: ultralytics.utils.colorstr
<br><br>
---
## ::: ultralytics.utils.remove_colorstr
<br><br>
---
## ::: ultralytics.utils.threaded
<br><br>
---
## ::: ultralytics.utils.set_sentry
<br><br>
---
## ::: ultralytics.utils.deprecation_warn
<br><br>
---
## ::: ultralytics.utils.clean_url
<br><br>
---
## ::: ultralytics.utils.url2file
<br><br>

View file

@ -9,10 +9,12 @@ keywords: Ultralytics, check_train_batch_size, autobatch, utility, machine learn
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/autobatch.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/autobatch.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/autobatch.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.utils.autobatch.check_train_batch_size
<br><br>
---
## ::: ultralytics.utils.autobatch.autobatch
## ::: ultralytics.utils.autobatch.check_train_batch_size
<br><br>
## ::: ultralytics.utils.autobatch.autobatch
<br><br>

View file

@ -9,10 +9,12 @@ keywords: Ultralytics, ProfileModels, benchmarks, model profiling, performance o
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/benchmarks.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/benchmarks.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/benchmarks.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.utils.benchmarks.ProfileModels
<br><br>
---
## ::: ultralytics.utils.benchmarks.benchmark
## ::: ultralytics.utils.benchmarks.ProfileModels
<br><br>
## ::: ultralytics.utils.benchmarks.benchmark
<br><br>

View file

@ -9,110 +9,112 @@ keywords: Ultralytics, Callbacks, On-train, On-validation, On-pretrain, On-predi
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/base.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/base.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/base.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.utils.callbacks.base.on_pretrain_routine_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_pretrain_routine_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_train_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_train_epoch_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_train_batch_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.optimizer_step
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_before_zero_grad
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_train_batch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_train_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_fit_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_model_save
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_train_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_params_update
<br><br>
---
## ::: ultralytics.utils.callbacks.base.teardown
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_val_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_val_batch_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_val_batch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_val_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_predict_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_predict_batch_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_predict_batch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_predict_postprocess_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_predict_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_export_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_export_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.get_default_callbacks
<br><br>
---
## ::: ultralytics.utils.callbacks.base.add_integration_callbacks
<br><br>

View file

@ -9,30 +9,32 @@ keywords: Ultralytics, clearML, callbacks, pretrain routine start, validation en
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/clearml.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/clearml.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/clearml.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.utils.callbacks.clearml._log_debug_samples
<br><br>
---
## ::: ultralytics.utils.callbacks.clearml._log_plot
<br><br>
---
## ::: ultralytics.utils.callbacks.clearml.on_pretrain_routine_start
<br><br>
---
## ::: ultralytics.utils.callbacks.clearml.on_train_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.clearml.on_fit_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.clearml.on_val_end
<br><br>
---
## ::: ultralytics.utils.callbacks.clearml.on_train_end
<br><br>

View file

@ -9,98 +9,100 @@ keywords: Ultralytics, Comet Callbacks, Training optimisation, Logging, Experime
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/comet.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/comet.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/comet.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.utils.callbacks.comet._get_comet_mode
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._get_comet_model_name
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._get_eval_batch_logging_interval
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._get_max_image_predictions_to_log
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._scale_confidence_score
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._should_log_confusion_matrix
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._should_log_image_predictions
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._get_experiment_type
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._create_experiment
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._fetch_trainer_metadata
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._scale_bounding_box_to_original_image_shape
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._format_ground_truth_annotations_for_detection
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._format_prediction_annotations_for_detection
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._fetch_annotations
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._create_prediction_metadata_map
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._log_confusion_matrix
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._log_images
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._log_image_predictions
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._log_plots
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._log_model
<br><br>
---
## ::: ultralytics.utils.callbacks.comet.on_pretrain_routine_start
<br><br>
---
## ::: ultralytics.utils.callbacks.comet.on_train_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.comet.on_fit_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.comet.on_train_end
<br><br>

View file

@ -9,38 +9,40 @@ keywords: Ultralytics, YOLO, callbacks, logger, training, pretraining, machine l
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/dvc.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/dvc.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/dvc.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.utils.callbacks.dvc._log_images
<br><br>
---
## ::: ultralytics.utils.callbacks.dvc._log_plots
<br><br>
---
## ::: ultralytics.utils.callbacks.dvc._log_confusion_matrix
<br><br>
---
## ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_start
<br><br>
---
## ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_end
<br><br>
---
## ::: ultralytics.utils.callbacks.dvc.on_train_start
<br><br>
---
## ::: ultralytics.utils.callbacks.dvc.on_train_epoch_start
<br><br>
---
## ::: ultralytics.utils.callbacks.dvc.on_fit_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.dvc.on_train_end
<br><br>

View file

@ -9,34 +9,36 @@ keywords: Ultralytics, callbacks, on_pretrain_routine_end, on_model_save, on_tra
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/hub.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/hub.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/hub.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.utils.callbacks.hub.on_pretrain_routine_end
<br><br>
---
## ::: ultralytics.utils.callbacks.hub.on_fit_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.hub.on_model_save
<br><br>
---
## ::: ultralytics.utils.callbacks.hub.on_train_end
<br><br>
---
## ::: ultralytics.utils.callbacks.hub.on_train_start
<br><br>
---
## ::: ultralytics.utils.callbacks.hub.on_val_start
<br><br>
---
## ::: ultralytics.utils.callbacks.hub.on_predict_start
<br><br>
---
## ::: ultralytics.utils.callbacks.hub.on_export_start
<br><br>

View file

@ -9,14 +9,16 @@ keywords: Ultralytics, MLflow, Callbacks, on_pretrain_routine_end, on_train_end,
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/mlflow.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/mlflow.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/mlflow.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.utils.callbacks.mlflow.on_pretrain_routine_end
<br><br>
---
## ::: ultralytics.utils.callbacks.mlflow.on_fit_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.mlflow.on_train_end
<br><br>

View file

@ -9,34 +9,36 @@ keywords: Ultralytics, Neptune callbacks, on_train_epoch_end, on_val_end, _log_p
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/neptune.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/neptune.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/neptune.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.utils.callbacks.neptune._log_scalars
<br><br>
---
## ::: ultralytics.utils.callbacks.neptune._log_images
<br><br>
---
## ::: ultralytics.utils.callbacks.neptune._log_plot
<br><br>
---
## ::: ultralytics.utils.callbacks.neptune.on_pretrain_routine_start
<br><br>
---
## ::: ultralytics.utils.callbacks.neptune.on_train_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.neptune.on_fit_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.neptune.on_val_end
<br><br>
---
## ::: ultralytics.utils.callbacks.neptune.on_train_end
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, YOLO, on_fit_epoch_end, callbacks, documentation, deep le
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/raytune.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/raytune.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/raytune.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.utils.callbacks.raytune.on_fit_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.raytune.on_fit_epoch_end
<br><br>

View file

@ -9,26 +9,28 @@ keywords: Ultralytics, YOLO, documentation, callback utilities, log_scalars, on_
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/tensorboard.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/tensorboard.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/tensorboard.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.utils.callbacks.tensorboard._log_scalars
<br><br>
---
## ::: ultralytics.utils.callbacks.tensorboard._log_tensorboard_graph
<br><br>
---
## ::: ultralytics.utils.callbacks.tensorboard.on_pretrain_routine_start
<br><br>
---
## ::: ultralytics.utils.callbacks.tensorboard.on_train_start
<br><br>
---
## ::: ultralytics.utils.callbacks.tensorboard.on_batch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.tensorboard.on_fit_epoch_end
<br><br>

View file

@ -9,30 +9,32 @@ keywords: Ultralytics, callbacks, _log_plots, on_fit_epoch_end, on_train_end
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/wb.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/wb.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/wb.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.utils.callbacks.wb._custom_table
<br><br>
---
## ::: ultralytics.utils.callbacks.wb._plot_curve
<br><br>
---
## ::: ultralytics.utils.callbacks.wb._log_plots
<br><br>
---
## ::: ultralytics.utils.callbacks.wb.on_pretrain_routine_start
<br><br>
---
## ::: ultralytics.utils.callbacks.wb.on_fit_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.wb.on_train_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.wb.on_train_end
<br><br>

View file

@ -9,102 +9,104 @@ keywords: Ultralytics, utility checks, ASCII, check_version, pip_update, check_p
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/checks.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/checks.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/checks.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.utils.checks.parse_requirements
<br><br>
---
## ::: ultralytics.utils.checks.parse_version
<br><br>
---
## ::: ultralytics.utils.checks.is_ascii
<br><br>
---
## ::: ultralytics.utils.checks.check_imgsz
<br><br>
---
## ::: ultralytics.utils.checks.check_version
<br><br>
---
## ::: ultralytics.utils.checks.check_latest_pypi_version
<br><br>
---
## ::: ultralytics.utils.checks.check_pip_update_available
<br><br>
---
## ::: ultralytics.utils.checks.check_font
<br><br>
---
## ::: ultralytics.utils.checks.check_python
<br><br>
---
## ::: ultralytics.utils.checks.check_requirements
<br><br>
---
## ::: ultralytics.utils.checks.check_torchvision
<br><br>
---
## ::: ultralytics.utils.checks.check_suffix
<br><br>
---
## ::: ultralytics.utils.checks.check_yolov5u_filename
<br><br>
---
## ::: ultralytics.utils.checks.check_model_file_from_stem
<br><br>
---
## ::: ultralytics.utils.checks.check_file
<br><br>
---
## ::: ultralytics.utils.checks.check_yaml
<br><br>
---
## ::: ultralytics.utils.checks.check_is_path_safe
<br><br>
---
## ::: ultralytics.utils.checks.check_imshow
<br><br>
---
## ::: ultralytics.utils.checks.check_yolo
<br><br>
---
## ::: ultralytics.utils.checks.collect_system_info
<br><br>
---
## ::: ultralytics.utils.checks.check_amp
<br><br>
---
## ::: ultralytics.utils.checks.git_describe
<br><br>
---
## ::: ultralytics.utils.checks.print_args
<br><br>
---
## ::: ultralytics.utils.checks.cuda_device_count
<br><br>
---
## ::: ultralytics.utils.checks.cuda_is_available
<br><br>

View file

@ -9,18 +9,20 @@ keywords: Ultralytics, DDP, DDP utility functions, Distributed Data Processing,
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/dist.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/dist.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/dist.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.utils.dist.find_free_network_port
<br><br>
---
## ::: ultralytics.utils.dist.generate_ddp_file
<br><br>
---
## ::: ultralytics.utils.dist.generate_ddp_command
<br><br>
---
## ::: ultralytics.utils.dist.ddp_cleanup
<br><br>

View file

@ -9,42 +9,44 @@ keywords: Ultralytics, YOLO, download utilities, is_url, check_disk_space, get_g
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/downloads.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/downloads.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/downloads.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.utils.downloads.is_url
<br><br>
---
## ::: ultralytics.utils.downloads.delete_dsstore
<br><br>
---
## ::: ultralytics.utils.downloads.zip_directory
<br><br>
---
## ::: ultralytics.utils.downloads.unzip_file
<br><br>
---
## ::: ultralytics.utils.downloads.check_disk_space
<br><br>
---
## ::: ultralytics.utils.downloads.get_google_drive_file_info
<br><br>
---
## ::: ultralytics.utils.downloads.safe_download
<br><br>
---
## ::: ultralytics.utils.downloads.get_github_assets
<br><br>
---
## ::: ultralytics.utils.downloads.attempt_download_asset
<br><br>
---
## ::: ultralytics.utils.downloads.download
<br><br>

View file

@ -9,6 +9,8 @@ keywords: Ultralytics, HUBModelError, Machine Learning, Error troubleshooting, U
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/errors.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/errors.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/errors.py) 🛠️. Thank you 🙏!
---
## ::: ultralytics.utils.errors.HUBModelError
<br><br>
## ::: ultralytics.utils.errors.HUBModelError
<br><br>

View file

@ -9,30 +9,32 @@ keywords: Ultralytics, utility functions, file operations, working directory, fi
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/files.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/files.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/files.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.utils.files.WorkingDirectory
<br><br>
---
## ::: ultralytics.utils.files.spaces_in_path
<br><br>
---
## ::: ultralytics.utils.files.increment_path
<br><br>
---
## ::: ultralytics.utils.files.file_age
<br><br>
---
## ::: ultralytics.utils.files.file_date
<br><br>
---
## ::: ultralytics.utils.files.file_size
<br><br>
---
## ::: ultralytics.utils.files.get_latest_run
<br><br>

View file

@ -9,14 +9,16 @@ keywords: Ultralytics, Bboxes, _ntuple, utility, ultralytics utils.instance
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/instance.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/instance.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/instance.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.utils.instance.Bboxes
<br><br>
---
## ::: ultralytics.utils.instance.Instances
<br><br>
---
## ::: ultralytics.utils.instance._ntuple
<br><br>

View file

@ -9,34 +9,36 @@ keywords: Ultralytics, Loss functions, VarifocalLoss, BboxLoss, v8DetectionLoss,
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/loss.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/loss.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/loss.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.utils.loss.VarifocalLoss
<br><br>
---
## ::: ultralytics.utils.loss.FocalLoss
<br><br>
---
## ::: ultralytics.utils.loss.BboxLoss
<br><br>
---
## ::: ultralytics.utils.loss.KeypointLoss
<br><br>
---
## ::: ultralytics.utils.loss.v8DetectionLoss
<br><br>
---
## ::: ultralytics.utils.loss.v8SegmentationLoss
<br><br>
---
## ::: ultralytics.utils.loss.v8PoseLoss
<br><br>
---
## ::: ultralytics.utils.loss.v8ClassificationLoss
<br><br>

View file

@ -9,70 +9,72 @@ keywords: Ultralytics, YOLO, YOLOv3, YOLOv4, metrics, confusion matrix, detectio
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/metrics.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/metrics.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/metrics.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.utils.metrics.ConfusionMatrix
<br><br>
---
## ::: ultralytics.utils.metrics.Metric
<br><br>
---
## ::: ultralytics.utils.metrics.DetMetrics
<br><br>
---
## ::: ultralytics.utils.metrics.SegmentMetrics
<br><br>
---
## ::: ultralytics.utils.metrics.PoseMetrics
<br><br>
---
## ::: ultralytics.utils.metrics.ClassifyMetrics
<br><br>
---
## ::: ultralytics.utils.metrics.bbox_ioa
<br><br>
---
## ::: ultralytics.utils.metrics.box_iou
<br><br>
---
## ::: ultralytics.utils.metrics.bbox_iou
<br><br>
---
## ::: ultralytics.utils.metrics.mask_iou
<br><br>
---
## ::: ultralytics.utils.metrics.kpt_iou
<br><br>
---
## ::: ultralytics.utils.metrics.smooth_BCE
<br><br>
---
## ::: ultralytics.utils.metrics.smooth
<br><br>
---
## ::: ultralytics.utils.metrics.plot_pr_curve
<br><br>
---
## ::: ultralytics.utils.metrics.plot_mc_curve
<br><br>
---
## ::: ultralytics.utils.metrics.compute_ap
<br><br>
---
## ::: ultralytics.utils.metrics.ap_per_class
<br><br>

View file

@ -9,118 +9,120 @@ keywords: Ultralytics YOLO, Utility Operations, segment2box, make_divisible, cli
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/ops.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/ops.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/ops.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.utils.ops.Profile
<br><br>
---
## ::: ultralytics.utils.ops.segment2box
<br><br>
---
## ::: ultralytics.utils.ops.scale_boxes
<br><br>
---
## ::: ultralytics.utils.ops.make_divisible
<br><br>
---
## ::: ultralytics.utils.ops.non_max_suppression
<br><br>
---
## ::: ultralytics.utils.ops.clip_boxes
<br><br>
---
## ::: ultralytics.utils.ops.clip_coords
<br><br>
---
## ::: ultralytics.utils.ops.scale_image
<br><br>
---
## ::: ultralytics.utils.ops.xyxy2xywh
<br><br>
---
## ::: ultralytics.utils.ops.xywh2xyxy
<br><br>
---
## ::: ultralytics.utils.ops.xywhn2xyxy
<br><br>
---
## ::: ultralytics.utils.ops.xyxy2xywhn
<br><br>
---
## ::: ultralytics.utils.ops.xywh2ltwh
<br><br>
---
## ::: ultralytics.utils.ops.xyxy2ltwh
<br><br>
---
## ::: ultralytics.utils.ops.ltwh2xywh
<br><br>
---
## ::: ultralytics.utils.ops.xyxyxyxy2xywhr
<br><br>
---
## ::: ultralytics.utils.ops.xywhr2xyxyxyxy
<br><br>
---
## ::: ultralytics.utils.ops.ltwh2xyxy
<br><br>
---
## ::: ultralytics.utils.ops.segments2boxes
<br><br>
---
## ::: ultralytics.utils.ops.resample_segments
<br><br>
---
## ::: ultralytics.utils.ops.crop_mask
<br><br>
---
## ::: ultralytics.utils.ops.process_mask_upsample
<br><br>
---
## ::: ultralytics.utils.ops.process_mask
<br><br>
---
## ::: ultralytics.utils.ops.process_mask_native
<br><br>
---
## ::: ultralytics.utils.ops.scale_masks
<br><br>
---
## ::: ultralytics.utils.ops.scale_coords
<br><br>
---
## ::: ultralytics.utils.ops.masks2segments
<br><br>
---
## ::: ultralytics.utils.ops.convert_torch2numpy_batch
<br><br>
---
## ::: ultralytics.utils.ops.clean_str
<br><br>

View file

@ -9,18 +9,20 @@ keywords: Ultralytics, Utils, Patches, imread, imshow, torch_save, image process
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/patches.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/patches.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/patches.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.utils.patches.imread
<br><br>
---
## ::: ultralytics.utils.patches.imwrite
<br><br>
---
## ::: ultralytics.utils.patches.imshow
<br><br>
---
## ::: ultralytics.utils.patches.torch_save
<br><br>

View file

@ -9,42 +9,44 @@ keywords: Ultralytics, plotting, utils, color annotation, label plotting, image
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/plotting.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/plotting.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/plotting.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.utils.plotting.Colors
<br><br>
---
## ::: ultralytics.utils.plotting.Annotator
<br><br>
---
## ::: ultralytics.utils.plotting.plot_labels
<br><br>
---
## ::: ultralytics.utils.plotting.save_one_box
<br><br>
---
## ::: ultralytics.utils.plotting.plot_images
<br><br>
---
## ::: ultralytics.utils.plotting.plot_results
<br><br>
---
## ::: ultralytics.utils.plotting.plt_color_scatter
<br><br>
---
## ::: ultralytics.utils.plotting.plot_tune_results
<br><br>
---
## ::: ultralytics.utils.plotting.output_to_target
<br><br>
---
## ::: ultralytics.utils.plotting.feature_visualization
<br><br>

View file

@ -9,26 +9,28 @@ keywords: Ultralytics, task aligned assigner, select highest overlaps, make anch
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/tal.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/tal.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/tal.py) 🛠️. Thank you 🙏!
---
<br><br>
## ::: ultralytics.utils.tal.TaskAlignedAssigner
<br><br>
---
## ::: ultralytics.utils.tal.select_candidates_in_gts
<br><br>
---
## ::: ultralytics.utils.tal.select_highest_overlaps
<br><br>
---
## ::: ultralytics.utils.tal.make_anchors
<br><br>
---
## ::: ultralytics.utils.tal.dist2bbox
<br><br>
---
## ::: ultralytics.utils.tal.bbox2dist
<br><br>

Some files were not shown because too many files have changed in this diff Show more