v1.0

docs/en/reference/engine/trainer.md

+---
+description: Learn about the BaseTrainer class in the Ultralytics library. From training control, customization to advanced usage.
+keywords: Ultralytics, BaseTrainer, Machine Learning, Training Control, Python library
+---
+
+# 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><br>
+
+## ::: ultralytics.engine.trainer.BaseTrainer
+
+<br><br>

docs/en/reference/engine/tuner.md

+---
+description: Explore the Ultralytics Tuner, a powerful tool designed for hyperparameter tuning of YOLO models to optimize performance across various tasks like object detection, image classification, and more.
+keywords: Ultralytics, Tuner, YOLO, hyperparameter tuning, optimization, object detection, image classification, instance segmentation, 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><br>
+
+## ::: ultralytics.engine.tuner.Tuner
+
+<br><br>

docs/en/reference/engine/validator.md

+---
+description: Learn about the Ultralytics BaseValidator module. Understand its principles, uses, and how it interacts with other components.
+keywords: Ultralytics, BaseValidator, Ultralytics engine, module, components
+---
+
+# 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><br>
+
+## ::: ultralytics.engine.validator.BaseValidator
+
+<br><br>

docs/en/reference/hub/__init__.md

+---
+description: Explore Ultralytics hub functions for model resetting, checking datasets, model exporting and more. Easy-to-follow instructions provided.
+keywords: Ultralytics, hub functions, model export, dataset check, reset model, YOLO Docs
+---
+
+# 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><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>

docs/en/reference/hub/auth.md

+---
+description: Dive into the Ultralytics Auth API documentation & learn how to manage authentication in your AI & ML projects easily and effectively.
+keywords: Ultralytics, Auth, API documentation, User Authentication, AI, Machine Learning
+---
+
+# 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><br>
+
+## ::: ultralytics.hub.auth.Auth
+
+<br><br>

docs/en/reference/hub/session.md

+---
+description: Explore details about the HUBTrainingSession in Ultralytics framework. Learn to utilize this functionality for effective model training.
+keywords: Ultralytics, HUBTrainingSession, Documentation, Model Training, AI, Machine Learning, YOLO
+---
+
+# 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><br>
+
+## ::: ultralytics.hub.session.HUBTrainingSession
+
+<br><br>

docs/en/reference/hub/utils.md

+---
+description: Explore Ultralytics docs for various Events, including "request_with_credentials" and "requests_with_progress". Also, understand the use of the "smart_request".
+keywords: Ultralytics, Events, request_with_credentials, smart_request, Ultralytics hub utils, requests_with_progress
+---
+
+# 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><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>

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

+---
+description: Learn all about Ultralytics FastSAM model. Dive into our comprehensive guide for seamless integration and efficient model training.
+keywords: Ultralytics, FastSAM model, Model documentation, Efficient model training
+---
+
+# 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><br>
+
+## ::: ultralytics.models.fastsam.model.FastSAM
+
+<br><br>

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

+---
+description: Get detailed insights about Ultralytics FastSAMPredictor. Learn to predict and optimize your AI models with our properly documented guidelines.
+keywords: Ultralytics, FastSAMPredictor, predictive modeling, AI optimization, machine learning, deep learning, Ultralytics documentation
+---
+
+# 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><br>
+
+## ::: ultralytics.models.fastsam.predict.FastSAMPredictor
+
+<br><br>

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

+---
+description: Learn to effectively utilize FastSAMPrompt model from Ultralytics. Detailed guide to help you get the most out of your machine learning models.
+keywords: Ultralytics, FastSAMPrompt, machine learning, model, guide, documentation
+---
+
+# Reference for `ultralytics/models/fastsam/prompt.py`
+
+!!! Note
+
+    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 🙏!
+
+<br><br>
+
+## ::: ultralytics.models.fastsam.prompt.FastSAMPrompt
+
+<br><br>

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

+---
+description: Learn how to adjust bounding boxes to image borders in Ultralytics models using the bbox_iou utility. Enhance your object detection performance.
+keywords: Ultralytics, bounding boxes, Bboxes, image borders, object detection, bbox_iou, model utilities
+---
+
+# 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><br>
+
+## ::: ultralytics.models.fastsam.utils.adjust_bboxes_to_image_border
+
+<br><br>
+
+## ::: ultralytics.models.fastsam.utils.bbox_iou
+
+<br><br>

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

+---
+description: Learn about FastSAMValidator in Ultralytics models. Comprehensive guide to enhancing AI capabilities with Ultralytics.
+keywords: Ultralytics, FastSAMValidator, model, synthetic, AI, machine learning, validation
+---
+
+# 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><br>
+
+## ::: ultralytics.models.fastsam.val.FastSAMValidator
+
+<br><br>

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

+---
+description: Learn how our NAS model operates in Ultralytics. Comprehensive guide with detailed examples. Master the nuances of Ultralytics NAS model.
+keywords: Ultralytics, NAS model, NAS guide, machine learning, model documentation
+---
+
+# 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><br>
+
+## ::: ultralytics.models.nas.model.NAS
+
+<br><br>

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

+---
+description: Explore Ultralytics NASPredictor. Understand high-level architecture of the model for effective implementation and efficient predictions.
+keywords: NASPredictor, Ultralytics, Ultralytics model, model architecture, efficient predictions
+---
+
+# 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><br>
+
+## ::: ultralytics.models.nas.predict.NASPredictor
+
+<br><br>

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

+---
+description: Explore the utilities and functions of the Ultralytics NASValidator. Find out how it benefits allocation and optimization in AI models.
+keywords: Ultralytics, NASValidator, models.nas.val.NASValidator, AI models, allocation, optimization
+---
+
+# Reference for `ultralytics/models/nas/val.py`
+
+!!! Note
+
+    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 🙏!
+
+<br><br>
+
+## ::: ultralytics.models.nas.val.NASValidator
+
+<br><br>

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

+---
+description: Explore the specifics of using the RTDETR model in Ultralytics. Detailed documentation layered with explanations and examples.
+keywords: Ultralytics, RTDETR model, Ultralytics models, object detection, Ultralytics documentation
+---
+
+# Reference for `ultralytics/models/rtdetr/model.py`
+
+!!! Note
+
+    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 🙏!
+
+<br><br>
+
+## ::: ultralytics.models.rtdetr.model.RTDETR
+
+<br><br>

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

+---
+description: Learn how to use the RTDETRPredictor model of the Ultralytics package. Detailed documentation, usage instructions, and advice.
+keywords: Ultralytics, RTDETRPredictor, model documentation, guide, real-time object detection
+---
+
+# Reference for `ultralytics/models/rtdetr/predict.py`
+
+!!! Note
+
+    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 🙏!
+
+<br><br>
+
+## ::: ultralytics.models.rtdetr.predict.RTDETRPredictor
+
+<br><br>

docs/en/reference/models/rtdetr/train.md

+---
+description: Get insights into RTDETRTrainer, a crucial component of Ultralytics for effective model training. Explore detailed documentation at Ultralytics.
+keywords: Ultralytics, RTDETRTrainer, model training, Ultralytics models, PyTorch models, neural networks, machine learning, deep learning
+---
+
+# Reference for `ultralytics/models/rtdetr/train.py`
+
+!!! Note
+
+    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 🙏!
+
+<br><br>
+
+## ::: ultralytics.models.rtdetr.train.RTDETRTrainer
+
+<br><br>

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

+---
+description: Explore RTDETRDataset in Ultralytics Models. Learn about the RTDETRValidator function, understand its usage in real-time object detection.
+keywords: Ultralytics, RTDETRDataset, RTDETRValidator, real-time object detection, models documentation
+---
+
+# Reference for `ultralytics/models/rtdetr/val.py`
+
+!!! Note
+
+    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 🙏!
+
+<br><br>
+
+## ::: ultralytics.models.rtdetr.val.RTDETRDataset
+
+<br><br>
+
+## ::: ultralytics.models.rtdetr.val.RTDETRValidator
+
+<br><br>

docs/en/reference/models/sam/amg.md

+---
+description: Explore Ultralytics methods for mask data processing, transformation and encoding. Deepen your understanding of RLE encoding, image cropping and more.
+keywords: Ultralytics, Mask Data, Transformation, Encoding, RLE encoding, Image cropping, Pytorch, SAM, AMG, Ultralytics model
+---
+
+# Reference for `ultralytics/models/sam/amg.py`
+
+!!! Note
+
+    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>