v1.0

docs/en/reference/data/split_dota.md

+---
+description: Learn how to utilize the ultralytics.data.split_dota module to process and split DOTA datasets efficiently. Explore detailed functions and examples.
+keywords: Ultralytics, DOTA dataset, data splitting, YOLO, Python, bbox_iof, load_yolo_dota, get_windows, crop_and_save
+---
+
+# Reference for `ultralytics/data/split_dota.py`
+
+!!! note
+
+    This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/split_dota.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/split_dota.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/split_dota.py) 🛠️. Thank you 🙏!
+
+<br>
+
+## ::: ultralytics.data.split_dota.bbox_iof
+
+<br><br><hr><br>
+
+## ::: ultralytics.data.split_dota.load_yolo_dota
+
+<br><br><hr><br>
+
+## ::: ultralytics.data.split_dota.get_windows
+
+<br><br><hr><br>
+
+## ::: ultralytics.data.split_dota.get_window_obj
+
+<br><br><hr><br>
+
+## ::: ultralytics.data.split_dota.crop_and_save
+
+<br><br><hr><br>
+
+## ::: ultralytics.data.split_dota.split_images_and_labels
+
+<br><br><hr><br>
+
+## ::: ultralytics.data.split_dota.split_trainval
+
+<br><br><hr><br>
+
+## ::: ultralytics.data.split_dota.split_test
+
+<br><br>

docs/en/reference/data/utils.md

+---
+description: Explore in-depth reference for utility functions in Ultralytics data module. Learn about image verification, dataset handling, and more.
+keywords: Ultralytics, dataset utils, data handling, image verification, Python, data module
+---
+
+# Reference for `ultralytics/data/utils.py`
+
+!!! note
+
+    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>
+
+## ::: ultralytics.data.utils.HUBDatasetStats
+
+<br><br><hr><br>
+
+## ::: ultralytics.data.utils.img2label_paths
+
+<br><br><hr><br>
+
+## ::: ultralytics.data.utils.get_hash
+
+<br><br><hr><br>
+
+## ::: ultralytics.data.utils.exif_size
+
+<br><br><hr><br>
+
+## ::: ultralytics.data.utils.verify_image
+
+<br><br><hr><br>
+
+## ::: ultralytics.data.utils.verify_image_label
+
+<br><br><hr><br>
+
+## ::: ultralytics.data.utils.polygon2mask
+
+<br><br><hr><br>
+
+## ::: ultralytics.data.utils.polygons2masks
+
+<br><br><hr><br>
+
+## ::: ultralytics.data.utils.polygons2masks_overlap
+
+<br><br><hr><br>
+
+## ::: ultralytics.data.utils.find_dataset_yaml
+
+<br><br><hr><br>
+
+## ::: ultralytics.data.utils.check_det_dataset
+
+<br><br><hr><br>
+
+## ::: ultralytics.data.utils.check_cls_dataset
+
+<br><br><hr><br>
+
+## ::: ultralytics.data.utils.compress_one_image
+
+<br><br><hr><br>
+
+## ::: ultralytics.data.utils.autosplit
+
+<br><br><hr><br>
+
+## ::: ultralytics.data.utils.load_dataset_cache_file
+
+<br><br><hr><br>
+
+## ::: ultralytics.data.utils.save_dataset_cache_file
+
+<br><br>

docs/en/reference/engine/exporter.md

+---
+description: Learn how to export YOLOv8 models to formats like ONNX, TensorRT, CoreML, and more. Optimize your exports for different platforms.
+keywords: YOLOv8, export formats, ONNX, TensorRT, CoreML, machine learning model export, AI, deep learning
+---
+
+# Reference for `ultralytics/engine/exporter.py`
+
+!!! note
+
+    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>
+
+## ::: ultralytics.engine.exporter.Exporter
+
+<br><br><hr><br>
+
+## ::: ultralytics.engine.exporter.IOSDetectModel
+
+<br><br><hr><br>
+
+## ::: ultralytics.engine.exporter.export_formats
+
+<br><br><hr><br>
+
+## ::: ultralytics.engine.exporter.gd_outputs
+
+<br><br><hr><br>
+
+## ::: ultralytics.engine.exporter.try_export
+
+<br><br>

docs/en/reference/engine/model.md

+---
+description: Explore the base class for implementing YOLO models with unified APIs for training, validation, prediction, and more. Learn how to utilize different task types and model configurations.
+keywords: YOLO model, Ultralytics, machine learning, deep learning, PyTorch model, training, validation, prediction, exporting, benchmarking, Ultralytics HUB, Triton Server
+---
+
+# Reference for `ultralytics/engine/model.py`
+
+!!! note
+
+    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 🙏!
+
+<br>
+
+## ::: ultralytics.engine.model.Model
+
+<br><br>

docs/en/reference/engine/predictor.md

+---
+description: Discover how to use the Base Predictor class in the Ultralytics YOLO engine for efficient image and video inference.
+keywords: Ultralytics, YOLO, Base Predictor, image inference, video inference, machine learning, Python
+---
+
+# Reference for `ultralytics/engine/predictor.py`
+
+!!! note
+
+    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 🙏!
+
+<br>
+
+## ::: ultralytics.engine.predictor.BasePredictor
+
+<br><br>

docs/en/reference/engine/results.md

+---
+description: Explore the details of Ultralytics engine results including classes like BaseTensor, Results, Boxes, Masks, Keypoints, Probs, and OBB to handle inference results efficiently.
+keywords: Ultralytics, engine results, BaseTensor, Results class, Boxes, Masks, Keypoints, Probs, OBB, inference results, machine learning, PyTorch
+---
+
+# Reference for `ultralytics/engine/results.py`
+
+!!! note
+
+    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>
+
+## ::: ultralytics.engine.results.BaseTensor
+
+<br><br><hr><br>
+
+## ::: ultralytics.engine.results.Results
+
+<br><br><hr><br>
+
+## ::: ultralytics.engine.results.Boxes
+
+<br><br><hr><br>
+
+## ::: ultralytics.engine.results.Masks
+
+<br><br><hr><br>
+
+## ::: ultralytics.engine.results.Keypoints
+
+<br><br><hr><br>
+
+## ::: ultralytics.engine.results.Probs
+
+<br><br><hr><br>
+
+## ::: ultralytics.engine.results.OBB
+
+<br><br>

docs/en/reference/engine/trainer.md

+---
+description: Learn how to use BaseTrainer in Ultralytics YOLO for efficient model training. Comprehensive guide for configurations, datasets, and optimization.
+keywords: Ultralytics, YOLO, BaseTrainer, model training, configuration, datasets, optimization, machine learning
+---
+
+# Reference for `ultralytics/engine/trainer.py`
+
+!!! note
+
+    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 🙏!
+
+<br>
+
+## ::: ultralytics.engine.trainer.BaseTrainer
+
+<br><br>

docs/en/reference/engine/tuner.md

+---
+description: Optimize YOLO model performance using Ultralytics Tuner. Learn about systematic hyperparameter tuning for object detection, segmentation, classification, and tracking.
+keywords: Ultralytics, YOLO, hyperparameter tuning, machine learning, deep learning, object detection, instance segmentation, image classification, pose estimation, multi-object tracking
+---
+
+# Reference for `ultralytics/engine/tuner.py`
+
+!!! note
+
+    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 🙏!
+
+<br>
+
+## ::: ultralytics.engine.tuner.Tuner
+
+<br><br>

docs/en/reference/engine/validator.md

+---
+description: Explore Ultralytics BaseValidator for model validation in PyTorch, TensorFlow, ONNX, and more. Learn to check model accuracy and performance metrics.
+keywords: Ultralytics, BaseValidator, model validation, PyTorch, TensorFlow, ONNX, model accuracy, performance metrics
+---
+
+# Reference for `ultralytics/engine/validator.py`
+
+!!! note
+
+    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 🙏!
+
+<br>
+
+## ::: ultralytics.engine.validator.BaseValidator
+
+<br><br>

docs/en/reference/hub/__init__.md

+---
+description: Explore Ultralytics HUB API functions for login, logout, model reset, export, and dataset checks. Enhance your YOLO workflows with these essential utilities.
+keywords: Ultralytics HUB API, login, logout, reset model, export model, check dataset, YOLO, machine learning
+---
+
+# Reference for `ultralytics/hub/__init__.py`
+
+!!! note
+
+    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>
+
+## ::: ultralytics.hub.login
+
+<br><br><hr><br>
+
+## ::: ultralytics.hub.logout
+
+<br><br><hr><br>
+
+## ::: ultralytics.hub.reset_model
+
+<br><br><hr><br>
+
+## ::: ultralytics.hub.export_fmts_hub
+
+<br><br><hr><br>
+
+## ::: ultralytics.hub.export_model
+
+<br><br><hr><br>
+
+## ::: ultralytics.hub.get_export
+
+<br><br><hr><br>
+
+## ::: ultralytics.hub.check_dataset
+
+<br><br>

docs/en/reference/hub/auth.md

+---
+description: Learn how to manage API key and cookie-based authentication in Ultralytics with the Auth class. Step-by-step guide for effective authentication.
+keywords: Ultralytics, authentication, API key, cookies, Auth class, YOLO, API, guide
+---
+
+# Reference for `ultralytics/hub/auth.py`
+
+!!! note
+
+    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 🙏!
+
+<br>
+
+## ::: ultralytics.hub.auth.Auth
+
+<br><br>

docs/en/reference/hub/google/__init__.md

+---
+description: Reference for the GCPRegions class in Ultralytics, which provides functionality for testing and analyzing latency across Google Cloud Platform regions.
+keywords: Ultralytics, GCP, Google Cloud Platform, regions, latency testing, cloud computing, networking, performance analysis
+---
+
+# Reference for `ultralytics/hub/google/__init__.py`
+
+!!! note
+
+    This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/google/\_\_init\_\_.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/google/__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/google/__init__.py) 🛠️. Thank you 🙏!
+
+<br>
+
+## ::: ultralytics.hub.google.GCPRegions
+
+<br><br>

docs/en/reference/hub/session.md

+---
+description: Explore the HUBTrainingSession class for managing Ultralytics YOLO model training, heartbeats, and checkpointing.
+keywords: Ultralytics, YOLO, HUBTrainingSession, model training, heartbeats, checkpointing, Python
+---
+
+# Reference for `ultralytics/hub/session.py`
+
+!!! note
+
+    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 🙏!
+
+<br>
+
+## ::: ultralytics.hub.session.HUBTrainingSession
+
+<br><br>

docs/en/reference/hub/utils.md

+---
+description: Explore the utilities in the Ultralytics HUB. Learn about smart_request, request_with_credentials, and more to enhance your YOLO projects.
+keywords: Ultralytics, HUB, Utilities, YOLO, smart_request, request_with_credentials
+---
+
+# Reference for `ultralytics/hub/utils.py`
+
+!!! note
+
+    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>
+
+## ::: ultralytics.hub.utils.Events
+
+<br><br><hr><br>
+
+## ::: ultralytics.hub.utils.request_with_credentials
+
+<br><br><hr><br>
+
+## ::: ultralytics.hub.utils.requests_with_progress
+
+<br><br><hr><br>
+
+## ::: ultralytics.hub.utils.smart_request
+
+<br><br>

docs/en/reference/models/fastsam/model.md

+---
+description: Discover how to use the FastSAM model with Ultralytics. Learn about its interface and implementation details with practical examples.
+keywords: FastSAM, Ultralytics, model interface, YOLO, deep learning, machine learning, segmentation, predictor, validator, Python
+---
+
+# Reference for `ultralytics/models/fastsam/model.py`
+
+!!! note
+
+    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 🙏!
+
+<br>
+
+## ::: ultralytics.models.fastsam.model.FastSAM
+
+<br><br>

docs/en/reference/models/fastsam/predict.md

+---
+description: Explore the Fast SAM Predictor in the Ultralytics YOLO framework. Learn about its segmentation prediction tasks, configuration, and post-processing steps.
+keywords: Ultralytics, Fast SAM Predictor, YOLO, segmentation, prediction, AI model, non-max suppression, mask prediction, tutorial
+---
+
+# Reference for `ultralytics/models/fastsam/predict.py`
+
+!!! note
+
+    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 🙏!
+
+<br>
+
+## ::: ultralytics.models.fastsam.predict.FastSAMPredictor
+
+<br><br>

docs/en/reference/models/fastsam/utils.md

+---
+description: Explore the utility functions in FastSAM for adjusting bounding boxes and calculating IoU, benefiting computer vision projects.
+keywords: FastSAM, bounding boxes, IoU, Ultralytics, image processing, computer vision
+---
+
+# Reference for `ultralytics/models/fastsam/utils.py`
+
+!!! note
+
+    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 🙏!
+
+<br>
+
+## ::: ultralytics.models.fastsam.utils.adjust_bboxes_to_image_border
+
+<br><br>

docs/en/reference/models/fastsam/val.md

+---
+description: Discover FastSAM Validator for segmentation in Ultralytics YOLO. Learn how to validate with custom metrics and avoid common errors. Contribute on GitHub!.
+keywords: FastSAM Validator, Ultralytics, YOLO, segmentation, validation, metrics, GitHub, contribute, documentation
+---
+
+# Reference for `ultralytics/models/fastsam/val.py`
+
+!!! note
+
+    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 🙏!
+
+<br>
+
+## ::: ultralytics.models.fastsam.val.FastSAMValidator
+
+<br><br>

docs/en/reference/models/nas/model.md

+---
+description: Explore the YOLO-NAS model interface and learn how to utilize pre-trained YOLO-NAS models for object detection with Ultralytics.
+keywords: Ultralytics, YOLO, YOLO-NAS, object detection, pre-trained models, machine learning, deep learning, NAS model
+---
+
+# Reference for `ultralytics/models/nas/model.py`
+
+!!! note
+
+    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 🙏!
+
+<br>
+
+## ::: ultralytics.models.nas.model.NAS
+
+<br><br>

docs/en/reference/models/nas/predict.md

+---
+description: Learn about NASPredictor in Ultralytics YOLO for efficient object detection. Explore its attributes, methods, and usage with examples.
+keywords: Ultralytics, YOLO, NASPredictor, object detection, machine learning, AI, non-maximum suppression, bounding boxes, image processing
+---
+
+# Reference for `ultralytics/models/nas/predict.py`
+
+!!! note
+
+    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 🙏!
+
+<br>
+
+## ::: ultralytics.models.nas.predict.NASPredictor
+
+<br><br>