feat: initial HSAP platform

Huaxu Sentinel Active Safety Platform with embedded algorithm code,
Docker Compose setup, and vendored dataset scaffolds for clone-and-run.

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
2026-05-25 16:59:59 +08:00
commit 7c43b44c57
1619 changed files with 373355 additions and 0 deletions

View File

@@ -0,0 +1,20 @@
---
description: Learn how Ultralytics uses lazy imports with __getattr__ to speed up package startup and load model classes like YOLO, NAS, RTDETR, and SAM only when needed.
keywords: Ultralytics, YOLO, lazy import, __getattr__, NAS, RTDETR, SAM, FastSAM, YOLOWorld, performance, startup time, optimization
---
# Reference for `ultralytics/__init__.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/\_\_init\_\_.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/__init__.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.__init__.__getattr__
<br><br><hr><br>
## ::: ultralytics.__init__.__dir__
<br><br>

View File

@@ -0,0 +1,68 @@
---
description: Explore the methods for managing and validating YOLO configurations in the Ultralytics configuration module. Enhance your YOLO experience.
keywords: Ultralytics, YOLO, configuration, cfg2dict, get_cfg, check_cfg, save_dir, deprecation, merge_args, yolo, settings, explorer
---
# Reference for `ultralytics/cfg/__init__.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/\_\_init\_\_.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/__init__.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.cfg.__init__.cfg2dict
<br><br><hr><br>
## ::: ultralytics.cfg.__init__.get_cfg
<br><br><hr><br>
## ::: ultralytics.cfg.__init__.check_cfg
<br><br><hr><br>
## ::: ultralytics.cfg.__init__.get_save_dir
<br><br><hr><br>
## ::: ultralytics.cfg.__init__._handle_deprecation
<br><br><hr><br>
## ::: ultralytics.cfg.__init__.check_dict_alignment
<br><br><hr><br>
## ::: ultralytics.cfg.__init__.merge_equals_args
<br><br><hr><br>
## ::: ultralytics.cfg.__init__.handle_yolo_hub
<br><br><hr><br>
## ::: ultralytics.cfg.__init__.handle_yolo_settings
<br><br><hr><br>
## ::: ultralytics.cfg.__init__.handle_yolo_solutions
<br><br><hr><br>
## ::: ultralytics.cfg.__init__.parse_key_value_pair
<br><br><hr><br>
## ::: ultralytics.cfg.__init__.smart_value
<br><br><hr><br>
## ::: ultralytics.cfg.__init__.entrypoint
<br><br><hr><br>
## ::: ultralytics.cfg.__init__.copy_default_cfg
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Explore Ultralytics' annotator script for automatic image annotation using YOLO and SAM models. Contribute to improve it on GitHub.
keywords: Ultralytics, image annotation, YOLO, SAM, Python script, GitHub, object detection, segmentation
---
# Reference for `ultralytics/data/annotator.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/annotator.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/annotator.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.data.annotator.auto_annotate
<br><br>

View File

@@ -0,0 +1,96 @@
---
description: Explore Ultralytics image augmentation techniques like MixUp, Mosaic, and Random Perspective for enhancing model training. Improve your deep learning models now.
keywords: Ultralytics, image augmentation, MixUp, Mosaic, Random Perspective, deep learning, model training, YOLO
---
# Reference for `ultralytics/data/augment.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/augment.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/augment.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.data.augment.BaseTransform
<br><br><hr><br>
## ::: ultralytics.data.augment.Compose
<br><br><hr><br>
## ::: ultralytics.data.augment.BaseMixTransform
<br><br><hr><br>
## ::: ultralytics.data.augment.Mosaic
<br><br><hr><br>
## ::: ultralytics.data.augment.MixUp
<br><br><hr><br>
## ::: ultralytics.data.augment.CutMix
<br><br><hr><br>
## ::: ultralytics.data.augment.RandomPerspective
<br><br><hr><br>
## ::: ultralytics.data.augment.RandomHSV
<br><br><hr><br>
## ::: ultralytics.data.augment.RandomFlip
<br><br><hr><br>
## ::: ultralytics.data.augment.LetterBox
<br><br><hr><br>
## ::: ultralytics.data.augment.CopyPaste
<br><br><hr><br>
## ::: ultralytics.data.augment.Albumentations
<br><br><hr><br>
## ::: ultralytics.data.augment.Format
<br><br><hr><br>
## ::: ultralytics.data.augment.LoadVisualPrompt
<br><br><hr><br>
## ::: ultralytics.data.augment.RandomLoadText
<br><br><hr><br>
## ::: ultralytics.data.augment.ClassifyLetterBox
<br><br><hr><br>
## ::: ultralytics.data.augment.CenterCrop
<br><br><hr><br>
## ::: ultralytics.data.augment.ToTensor
<br><br><hr><br>
## ::: ultralytics.data.augment.v8_transforms
<br><br><hr><br>
## ::: ultralytics.data.augment.classify_transforms
<br><br><hr><br>
## ::: ultralytics.data.augment.classify_augmentations
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Explore the Ultralytics BaseDataset class for efficient image loading and processing with custom transformations and caching options.
keywords: Ultralytics, BaseDataset, image processing, data augmentation, YOLO, dataset class, image caching
---
# Reference for `ultralytics/data/base.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/base.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/base.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.data.base.BaseDataset
<br><br>

View File

@@ -0,0 +1,48 @@
---
description: Explore the functionality and examples of data builders like InfiniteDataLoader and various YOLO dataset builders in Ultralytics.
keywords: Ultralytics, Data Builders, InfiniteDataLoader, YOLO dataset, build.py, AI, Machine Learning
---
# Reference for `ultralytics/data/build.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/build.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/build.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.data.build.InfiniteDataLoader
<br><br><hr><br>
## ::: ultralytics.data.build._RepeatSampler
<br><br><hr><br>
## ::: ultralytics.data.build.ContiguousDistributedSampler
<br><br><hr><br>
## ::: ultralytics.data.build.seed_worker
<br><br><hr><br>
## ::: ultralytics.data.build.build_yolo_dataset
<br><br><hr><br>
## ::: ultralytics.data.build.build_grounding
<br><br><hr><br>
## ::: ultralytics.data.build.build_dataloader
<br><br><hr><br>
## ::: ultralytics.data.build.check_source
<br><br><hr><br>
## ::: ultralytics.data.build.load_inference_source
<br><br>

View File

@@ -0,0 +1,56 @@
---
description: Explore comprehensive data conversion tools for YOLO models including COCO, DOTA, and YOLO bbox2segment converters.
keywords: Ultralytics, data conversion, YOLO models, COCO, DOTA, YOLO bbox2segment, machine learning, annotations
---
# Reference for `ultralytics/data/converter.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/converter.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/converter.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.data.converter.coco91_to_coco80_class
<br><br><hr><br>
## ::: ultralytics.data.converter.coco80_to_coco91_class
<br><br><hr><br>
## ::: ultralytics.data.converter.convert_coco
<br><br><hr><br>
## ::: ultralytics.data.converter.convert_segment_masks_to_yolo_seg
<br><br><hr><br>
## ::: ultralytics.data.converter.convert_dota_to_yolo_obb
<br><br><hr><br>
## ::: ultralytics.data.converter.min_index
<br><br><hr><br>
## ::: ultralytics.data.converter.merge_multi_segment
<br><br><hr><br>
## ::: ultralytics.data.converter.yolo_bbox2segment
<br><br><hr><br>
## ::: ultralytics.data.converter.create_synthetic_coco_dataset
<br><br><hr><br>
## ::: ultralytics.data.converter.convert_to_multispectral
<br><br><hr><br>
## ::: ultralytics.data.converter.convert_ndjson_to_yolo
<br><br>

View File

@@ -0,0 +1,36 @@
---
description: Explore the YOLODataset and its subclasses for object detection, segmentation, and multi-modal tasks. Find details on dataset loading, caching, and augmentation.
keywords: Ultralytics, YOLODataset, object detection, segmentation, dataset loading, caching, data augmentation
---
# Reference for `ultralytics/data/dataset.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/dataset.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/dataset.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.data.dataset.YOLODataset
<br><br><hr><br>
## ::: ultralytics.data.dataset.YOLOMultiModalDataset
<br><br><hr><br>
## ::: ultralytics.data.dataset.GroundingDataset
<br><br><hr><br>
## ::: ultralytics.data.dataset.YOLOConcatDataset
<br><br><hr><br>
## ::: ultralytics.data.dataset.SemanticDataset
<br><br><hr><br>
## ::: ultralytics.data.dataset.ClassificationDataset
<br><br>

View File

@@ -0,0 +1,44 @@
---
description: Explore detailed documentation on Ultralytics data loaders including SourceTypes, LoadStreams, and more. Enhance your ML workflows with our comprehensive guides.
keywords: Ultralytics, data loaders, SourceTypes, LoadStreams, LoadScreenshots, LoadImagesAndVideos, LoadPilAndNumpy, LoadTensor, ML workflows
---
# Reference for `ultralytics/data/loaders.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/loaders.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/loaders.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.data.loaders.SourceTypes
<br><br><hr><br>
## ::: ultralytics.data.loaders.LoadStreams
<br><br><hr><br>
## ::: ultralytics.data.loaders.LoadScreenshots
<br><br><hr><br>
## ::: ultralytics.data.loaders.LoadImagesAndVideos
<br><br><hr><br>
## ::: ultralytics.data.loaders.LoadPilAndNumpy
<br><br><hr><br>
## ::: ultralytics.data.loaders.LoadTensor
<br><br><hr><br>
## ::: ultralytics.data.loaders.autocast_list
<br><br><hr><br>
## ::: ultralytics.data.loaders.get_best_youtube_url
<br><br>

View File

@@ -0,0 +1,32 @@
---
description: TODO ADD DESCRIPTION
keywords: TODO ADD KEYWORDS
---
# Reference for `ultralytics/data/scripts/generate_coco12_formats.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/scripts/generate_coco12_formats.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/scripts/generate_coco12_formats.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.data.scripts.generate_coco12_formats.write_mpo
<br><br><hr><br>
## ::: ultralytics.data.scripts.generate_coco12_formats.write_dng
<br><br><hr><br>
## ::: ultralytics.data.scripts.generate_coco12_formats.convert_image
<br><br><hr><br>
## ::: ultralytics.data.scripts.generate_coco12_formats.generate_coco12_formats
<br><br><hr><br>
## ::: ultralytics.data.scripts.generate_coco12_formats.find_label
<br><br>

View File

@@ -0,0 +1,20 @@
---
description: Learn how to split datasets into train, validation, and test subsets using Ultralytics utilities for efficient data preparation.
keywords: dataset splitting, autosplit dataset, training dataset preparation, validation set creation, Ultralytics data tools
---
# Reference for `ultralytics/data/split.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/split.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/split.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.data.split.split_classify_dataset
<br><br><hr><br>
## ::: ultralytics.data.split.autosplit
<br><br>

View File

@@ -0,0 +1,44 @@
---
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`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/split_dota.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/split_dota.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — 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>

View File

@@ -0,0 +1,80 @@
---
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`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/utils.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.data.utils.HUBDatasetStats
<br><br><hr><br>
## ::: ultralytics.data.utils.img2label_paths
<br><br><hr><br>
## ::: ultralytics.data.utils.check_file_speeds
<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.visualize_image_annotations
<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.load_dataset_cache_file
<br><br><hr><br>
## ::: ultralytics.data.utils.save_dataset_cache_file
<br><br>

View File

@@ -0,0 +1,40 @@
---
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`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/exporter.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/exporter.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.engine.exporter.Exporter
<br><br><hr><br>
## ::: ultralytics.engine.exporter.IOSDetectModel
<br><br><hr><br>
## ::: ultralytics.engine.exporter.NMSModel
<br><br><hr><br>
## ::: ultralytics.engine.exporter.export_formats
<br><br><hr><br>
## ::: ultralytics.engine.exporter.best_onnx_opset
<br><br><hr><br>
## ::: ultralytics.engine.exporter.validate_args
<br><br><hr><br>
## ::: ultralytics.engine.exporter.try_export
<br><br>

View File

@@ -0,0 +1,16 @@
---
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 Platform, Triton Server
---
# Reference for `ultralytics/engine/model.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/model.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/model.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.engine.model.Model
<br><br>

View File

@@ -0,0 +1,16 @@
---
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`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/predictor.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/predictor.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.engine.predictor.BasePredictor
<br><br>

View File

@@ -0,0 +1,40 @@
---
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`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/results.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/results.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — 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>

View File

@@ -0,0 +1,16 @@
---
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`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/trainer.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/trainer.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.engine.trainer.BaseTrainer
<br><br>

View File

@@ -0,0 +1,16 @@
---
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`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/tuner.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/tuner.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.engine.tuner.Tuner
<br><br>

View File

@@ -0,0 +1,16 @@
---
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`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/validator.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/validator.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.engine.validator.BaseValidator
<br><br>

View File

@@ -0,0 +1,40 @@
---
description: Explore Ultralytics Platform API functions for login, logout, model reset, export, and dataset checks. Enhance your YOLO workflows with these essential utilities.
keywords: Ultralytics Platform API, login, logout, reset model, export model, check dataset, YOLO, machine learning
---
# Reference for `ultralytics/hub/__init__.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/\_\_init\_\_.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/__init__.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.hub.__init__.login
<br><br><hr><br>
## ::: ultralytics.hub.__init__.logout
<br><br><hr><br>
## ::: ultralytics.hub.__init__.reset_model
<br><br><hr><br>
## ::: ultralytics.hub.__init__.export_fmts_hub
<br><br><hr><br>
## ::: ultralytics.hub.__init__.export_model
<br><br><hr><br>
## ::: ultralytics.hub.__init__.get_export
<br><br><hr><br>
## ::: ultralytics.hub.__init__.check_dataset
<br><br>

View File

@@ -0,0 +1,16 @@
---
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`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/auth.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/auth.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.hub.auth.Auth
<br><br>

View File

@@ -0,0 +1,16 @@
---
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`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/google/\_\_init\_\_.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/google/__init__.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.hub.google.__init__.GCPRegions
<br><br>

View File

@@ -0,0 +1,16 @@
---
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`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/session.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/session.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.hub.session.HUBTrainingSession
<br><br>

View File

@@ -0,0 +1,24 @@
---
description: Explore the utilities in the Ultralytics Platform. 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`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/utils.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<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>

View File

@@ -0,0 +1,16 @@
---
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`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/model.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/model.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.fastsam.model.FastSAM
<br><br>

View File

@@ -0,0 +1,16 @@
---
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`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/predict.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.fastsam.predict.FastSAMPredictor
<br><br>

View File

@@ -0,0 +1,16 @@
---
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`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/utils.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.fastsam.utils.adjust_bboxes_to_image_border
<br><br>

View File

@@ -0,0 +1,16 @@
---
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`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/val.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.fastsam.val.FastSAMValidator
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Explore the YOLO-NAS model interface and learn how to utilize pretrained YOLO-NAS models for object detection with Ultralytics.
keywords: Ultralytics, YOLO, YOLO-NAS, object detection, pretrained models, machine learning, deep learning, NAS model
---
# Reference for `ultralytics/models/nas/model.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/nas/model.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/nas/model.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.nas.model.NAS
<br><br>

View File

@@ -0,0 +1,16 @@
---
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`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/nas/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/nas/predict.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.nas.predict.NASPredictor
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Explore the Ultralytics NASValidator for efficient YOLO model validation. Learn about NMS and post-processing configurations.
keywords: Ultralytics, YOLO, NASValidator, object detection, non-maximum suppression, NMS, YOLO models, machine learning
---
# Reference for `ultralytics/models/nas/val.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/nas/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/nas/val.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.nas.val.NASValidator
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Explore the interface for Baidu's RT-DETR, a Vision Transformer-based real-time object detector in the Ultralytics Docs. Learn more about its efficient hybrid encoding and IoU-aware query selection.
keywords: RT-DETR, real-time object detection, Vision Transformer, Ultralytics, model interface, Baidu, hybrid encoding, IoU-aware query selection, machine learning, AI
---
# Reference for `ultralytics/models/rtdetr/model.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/model.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/model.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.rtdetr.model.RTDETR
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Access the complete reference for the RTDETRPredictor class in Ultralytics. Learn about its attributes, methods, and example usage for real-time object detection.
keywords: RTDETRPredictor, Ultralytics, Real-Time Detection Transformer, object detection, Vision Transformers, documentation, RT-DETR, Python class
---
# Reference for `ultralytics/models/rtdetr/predict.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/predict.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.rtdetr.predict.RTDETRPredictor
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Explore RTDETRTrainer for efficient real-time object detection leveraging Vision Transformers. Learn configuration, dataset handling, and advanced model training.
keywords: RTDETRTrainer, real-time object detection, Vision Transformers, YOLO, RT-DETR model, model training, dataset handling
---
# Reference for `ultralytics/models/rtdetr/train.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/train.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/train.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.rtdetr.train.RTDETRTrainer
<br><br>

View File

@@ -0,0 +1,20 @@
---
description: Explore the RTDETRValidator and RTDETRDataset classes for real-time detection and tracking. Understand initialization, transformations, and post-processing.
keywords: RTDETR, Ultralytics, object detection, tracking, YOLO, RTDETRDataset, RTDETRValidator, real-time detection
---
# Reference for `ultralytics/models/rtdetr/val.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/val.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.rtdetr.val.RTDETRDataset
<br><br><hr><br>
## ::: ultralytics.models.rtdetr.val.RTDETRValidator
<br><br>

View File

@@ -0,0 +1,56 @@
---
description: Explore the detailed API reference for Ultralytics SAM/AMG models, including functions for mask stability scores, crop box generation, and more.
keywords: Ultralytics, SAM, AMG, API Reference, models, mask stability, crop boxes, data processing, YOLO
---
# Reference for `ultralytics/models/sam/amg.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/amg.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/amg.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.sam.amg.is_box_near_crop_edge
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.batch_iterator
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.calculate_stability_score
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.build_point_grid
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.build_all_layer_point_grids
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.generate_crop_boxes
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.uncrop_boxes_xyxy
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.uncrop_points
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.uncrop_masks
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.remove_small_regions
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.batched_mask_to_box
<br><br>

View File

@@ -0,0 +1,60 @@
---
description: Discover detailed instructions for building various Segment Anything Model (SAM) and Segment Anything Model 2 (SAM 2) architectures with Ultralytics, including SAM ViT and Mobile-SAM.
keywords: Ultralytics, SAM model, Segment Anything Model, SAM 2 model, Segment Anything Model 2, SAM ViT, Mobile-SAM, model building, deep learning, AI
---
# Reference for `ultralytics/models/sam/build.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/build.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/build.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.sam.build._load_checkpoint
<br><br><hr><br>
## ::: ultralytics.models.sam.build.build_sam_vit_h
<br><br><hr><br>
## ::: ultralytics.models.sam.build.build_sam_vit_l
<br><br><hr><br>
## ::: ultralytics.models.sam.build.build_sam_vit_b
<br><br><hr><br>
## ::: ultralytics.models.sam.build.build_mobile_sam
<br><br><hr><br>
## ::: ultralytics.models.sam.build.build_sam2_t
<br><br><hr><br>
## ::: ultralytics.models.sam.build.build_sam2_s
<br><br><hr><br>
## ::: ultralytics.models.sam.build.build_sam2_b
<br><br><hr><br>
## ::: ultralytics.models.sam.build.build_sam2_l
<br><br><hr><br>
## ::: ultralytics.models.sam.build._build_sam
<br><br><hr><br>
## ::: ultralytics.models.sam.build._build_sam2
<br><br><hr><br>
## ::: ultralytics.models.sam.build.build_sam
<br><br>

View File

@@ -0,0 +1,32 @@
---
description: Explore the ultralytics.models.sam.build_sam3 module for building SAM3 image models, including backbone and transformer components.
keywords: Ultralytics, SAM3, SAM, segmentation, transformer, ViTDet, model builder, Python
---
# Reference for `ultralytics/models/sam/build_sam3.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/build_sam3.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/build_sam3.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.sam.build_sam3._create_vision_backbone
<br><br><hr><br>
## ::: ultralytics.models.sam.build_sam3._create_sam3_transformer
<br><br><hr><br>
## ::: ultralytics.models.sam.build_sam3.build_sam3_image_model
<br><br><hr><br>
## ::: ultralytics.models.sam.build_sam3.build_interactive_sam3
<br><br><hr><br>
## ::: ultralytics.models.sam.build_sam3._load_checkpoint
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Explore the SAM (Segment Anything Model) and SAM 2 (Segment Anything Model 2) interface for real-time image segmentation. Learn about promptable segmentation and zero-shot capabilities.
keywords: Ultralytics, SAM, Segment Anything Model, SAM 2, Segment Anything Model 2, image segmentation, real-time segmentation, zero-shot performance, promptable segmentation, SA-1B dataset
---
# Reference for `ultralytics/models/sam/model.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/model.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/model.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.sam.model.SAM
<br><br>

View File

@@ -0,0 +1,72 @@
---
description: Explore detailed documentation of various SAM and SAM 2 modules such as MaskDownSampler, CXBlock, and more, available in Ultralytics' repository.
keywords: Ultralytics, SAM encoder, SAM 2 encoder, DropPath, MaskDownSampler, CXBlock, Fuser, TwoWayTransformer, TwoWayAttentionBlock, RoPEAttention, MultiScaleAttention, MultiScaleBlock, PositionEmbeddingSine, do_pool
---
# Reference for `ultralytics/models/sam/modules/blocks.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/blocks.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/blocks.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.sam.modules.blocks.DropPath
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.blocks.MaskDownSampler
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.blocks.CXBlock
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.blocks.Fuser
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.blocks.SAM2TwoWayAttentionBlock
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.blocks.SAM2TwoWayTransformer
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.blocks.RoPEAttention
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.blocks.MultiScaleAttention
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.blocks.MultiScaleBlock
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.blocks.PositionEmbeddingSine
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.blocks.PositionEmbeddingRandom
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.blocks.Block
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.blocks.REAttention
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.blocks.PatchEmbed
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.blocks.do_pool
<br><br>

View File

@@ -0,0 +1,20 @@
---
description: Explore the MaskDecoder and MLP modules in Ultralytics for efficient mask prediction using transformer architecture. Detailed attributes, functionalities, and implementation.
keywords: Ultralytics, MaskDecoder, MLP, machine learning, transformer architecture, mask prediction, neural networks, PyTorch modules
---
# Reference for `ultralytics/models/sam/modules/decoders.py`
!!! success "Improvements"
This page is sourced from [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). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.sam.modules.decoders.MaskDecoder
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.decoders.SAM2MaskDecoder
<br><br>

View File

@@ -0,0 +1,36 @@
---
description: Explore detailed documentation of various SAM encoder modules such as ImageEncoderViT, PromptEncoder, and more, available in Ultralytics' repository.
keywords: Ultralytics, SAM encoder, ImageEncoderViT, PromptEncoder, PositionEmbeddingRandom, Block, Attention, PatchEmbed
---
# Reference for `ultralytics/models/sam/modules/encoders.py`
!!! success "Improvements"
This page is sourced from [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). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.sam.modules.encoders.ImageEncoderViT
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.encoders.PromptEncoder
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.encoders.MemoryEncoder
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.encoders.ImageEncoder
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.encoders.FpnNeck
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.encoders.Hiera
<br><br>

View File

@@ -0,0 +1,20 @@
---
description: Explore detailed documentation of various SAM 2 encoder modules such as MemoryAttentionLayer, MemoryAttention, available in Ultralytics' repository.
keywords: Ultralytics, SAM 2 encoder, MemoryAttentionLayer, MemoryAttention
---
# Reference for `ultralytics/models/sam/modules/memory_attention.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/memory_attention.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/memory_attention.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.sam.modules.memory_attention.MemoryAttentionLayer
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.memory_attention.MemoryAttention
<br><br>

View File

@@ -0,0 +1,24 @@
---
description: Discover the Ultralytics SAM and SAM 2 module for object segmentation. Learn about its components, such as image encoders and mask decoders, in this comprehensive guide.
keywords: Ultralytics, SAM Module, SAM 2 Module, object segmentation, image encoder, mask decoder, prompt encoder, AI, machine learning
---
# Reference for `ultralytics/models/sam/modules/sam.py`
!!! success "Improvements"
This page is sourced from [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). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.sam.modules.sam.SAMModel
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.sam.SAM2Model
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.sam.SAM3Model
<br><br>

View File

@@ -0,0 +1,52 @@
---
description: Explore the detailed implementation of TinyViT architecture including Conv2d_BN, PatchEmbed, MBConv, and more in Ultralytics.
keywords: Ultralytics, TinyViT, Conv2d_BN, PatchEmbed, MBConv, Attention, PyTorch, YOLO, Deep Learning
---
# Reference for `ultralytics/models/sam/modules/tiny_encoder.py`
!!! success "Improvements"
This page is sourced from [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). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.sam.modules.tiny_encoder.Conv2d_BN
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.PatchEmbed
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.MBConv
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.PatchMerging
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.ConvLayer
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.MLP
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.Attention
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.TinyViTBlock
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.BasicLayer
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.TinyViT
<br><br>

View File

@@ -0,0 +1,24 @@
---
description: Explore the TwoWayTransformer module in Ultralytics, designed for simultaneous attention to image and query points. Ideal for object detection and segmentation tasks.
keywords: Ultralytics, TwoWayTransformer, module, deep learning, transformer, object detection, image segmentation, attention mechanism, neural networks
---
# Reference for `ultralytics/models/sam/modules/transformer.py`
!!! success "Improvements"
This page is sourced from [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). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.sam.modules.transformer.TwoWayTransformer
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.transformer.TwoWayAttentionBlock
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.transformer.Attention
<br><br>

View File

@@ -0,0 +1,60 @@
---
description: Explore the detailed API reference for Ultralytics SAM and SAM 2 models.
keywords: Ultralytics, SAM, SAM 2, API Reference, models, window partition, data processing, YOLO
---
# Reference for `ultralytics/models/sam/modules/utils.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/utils.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.sam.modules.utils.select_closest_cond_frames
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.utils.get_1d_sine_pe
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.utils.init_t_xy
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.utils.compute_axial_cis
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.utils.reshape_for_broadcast
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.utils.apply_rotary_enc
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.utils.window_partition
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.utils.window_unpartition
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.utils.get_rel_pos
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.utils.add_decomposed_rel_pos
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.utils.get_abs_pos
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.utils.concat_rel_pos
<br><br>

View File

@@ -0,0 +1,44 @@
---
description: Explore Ultralytics SAM and SAM 2 Predictor for advanced, real-time image segmentation using the Segment Anything Model (SAM and SAM 2). Complete implementation details and auxiliary utilities.
keywords: Ultralytics, SAM, Segment Anything Model, SAM 2, Segment Anything Model 2, image segmentation, real-time, prediction, AI, machine learning, Python, torch, inference
---
# Reference for `ultralytics/models/sam/predict.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/predict.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.sam.predict.Predictor
<br><br><hr><br>
## ::: ultralytics.models.sam.predict.SAM2Predictor
<br><br><hr><br>
## ::: ultralytics.models.sam.predict.SAM2VideoPredictor
<br><br><hr><br>
## ::: ultralytics.models.sam.predict.SAM2DynamicInteractivePredictor
<br><br><hr><br>
## ::: ultralytics.models.sam.predict.SAM3Predictor
<br><br><hr><br>
## ::: ultralytics.models.sam.predict.SAM3SemanticPredictor
<br><br><hr><br>
## ::: ultralytics.models.sam.predict.SAM3VideoPredictor
<br><br><hr><br>
## ::: ultralytics.models.sam.predict.SAM3VideoSemanticPredictor
<br><br>

View File

@@ -0,0 +1,20 @@
---
description: Explore the ultralytics.models.sam.sam3.decoder module, including transformer decoder layers used in SAM3 model heads.
keywords: Ultralytics, SAM3, SAM, transformer decoder, attention, segmentation, deep learning, Python
---
# Reference for `ultralytics/models/sam/sam3/decoder.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/sam3/decoder.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/sam3/decoder.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.sam.sam3.decoder.TransformerDecoderLayer
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.decoder.TransformerDecoder
<br><br>

View File

@@ -0,0 +1,28 @@
---
description: Explore the ultralytics.models.sam.sam3.encoder module, including transformer encoder layers and fusion blocks for SAM3.
keywords: Ultralytics, SAM3, SAM, transformer encoder, fusion, attention, deep learning, Python
---
# Reference for `ultralytics/models/sam/sam3/encoder.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/sam3/encoder.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/sam3/encoder.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.sam.sam3.encoder.TransformerEncoderLayer
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.encoder.TransformerEncoder
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.encoder.TransformerEncoderFusion
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.encoder.pool_text_feat
<br><br>

View File

@@ -0,0 +1,28 @@
---
description: Explore the ultralytics.models.sam.sam3.geometry_encoders module for prompt and geometry encoding utilities used by SAM3.
keywords: Ultralytics, SAM3, SAM, prompt encoder, geometry encoder, padding, embeddings, Python
---
# Reference for `ultralytics/models/sam/sam3/geometry_encoders.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/sam3/geometry_encoders.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/sam3/geometry_encoders.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.sam.sam3.geometry_encoders.Prompt
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.geometry_encoders.SequenceGeometryEncoder
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.geometry_encoders.is_right_padded
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.geometry_encoders.concat_padded_sequences
<br><br>

View File

@@ -0,0 +1,32 @@
---
description: Explore the ultralytics.models.sam.sam3.maskformer_segmentation module for segmentation heads and predictors used with SAM3.
keywords: Ultralytics, SAM3, MaskFormer, segmentation head, mask prediction, deep learning, Python, API reference
---
# Reference for `ultralytics/models/sam/sam3/maskformer_segmentation.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/sam3/maskformer_segmentation.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/sam3/maskformer_segmentation.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.sam.sam3.maskformer_segmentation.LinearPresenceHead
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.maskformer_segmentation.MaskPredictor
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.maskformer_segmentation.SegmentationHead
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.maskformer_segmentation.PixelDecoder
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.maskformer_segmentation.UniversalSegmentationHead
<br><br>

View File

@@ -0,0 +1,32 @@
---
description: Explore the ultralytics.models.sam.sam3.model_misc module with helper layers and utilities used in SAM3 model components.
keywords: Ultralytics, SAM3, SAM, transformer, layers, utilities, deep learning, Python
---
# Reference for `ultralytics/models/sam/sam3/model_misc.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/sam3/model_misc.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/sam3/model_misc.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.sam.sam3.model_misc.DotProductScoring
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.model_misc.LayerScale
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.model_misc.TransformerWrapper
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.model_misc.get_valid_ratio
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.model_misc.gen_sineembed_for_position
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Explore the ultralytics.models.sam.sam3.necks module for SAM3 neck components that connect vision backbones to downstream heads.
keywords: Ultralytics, SAM3, SAM, neck, backbone, ViTDet, segmentation, Python
---
# Reference for `ultralytics/models/sam/sam3/necks.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/sam3/necks.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/sam3/necks.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.sam.sam3.necks.Sam3DualViTDetNeck
<br><br>

View File

@@ -0,0 +1,20 @@
---
description: Explore the ultralytics.models.sam.sam3.sam3_image module, including the SAM3SemanticModel and related output helpers.
keywords: Ultralytics, SAM3, SAM, image segmentation, semantic segmentation, model, Python, API reference
---
# Reference for `ultralytics/models/sam/sam3/sam3_image.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/sam3/sam3_image.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/sam3/sam3_image.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.sam.sam3.sam3_image.SAM3SemanticModel
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.sam3_image._update_out
<br><br>

View File

@@ -0,0 +1,32 @@
---
description: Explore the ultralytics.models.sam.sam3.text_encoder_ve module for SAM3 text-encoder components used in vision-language pipelines.
keywords: Ultralytics, SAM3, SAM, text encoder, vision-language, transformer, tokenizer, Python
---
# Reference for `ultralytics/models/sam/sam3/text_encoder_ve.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/sam3/text_encoder_ve.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/sam3/text_encoder_ve.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.sam.sam3.text_encoder_ve.ResidualAttentionBlock
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.text_encoder_ve.Transformer
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.text_encoder_ve.TextTransformer
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.text_encoder_ve.VETextEncoder
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.text_encoder_ve.text_global_pool
<br><br>

View File

@@ -0,0 +1,52 @@
---
description: Explore the ultralytics.models.sam.sam3.tokenizer_ve module for tokenizer utilities used by SAM3 vision-language components.
keywords: Ultralytics, SAM3, tokenizer, BPE, text, vision-language, utilities, Python
---
# Reference for `ultralytics/models/sam/sam3/tokenizer_ve.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/sam3/tokenizer_ve.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/sam3/tokenizer_ve.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.sam.sam3.tokenizer_ve.SimpleTokenizer
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.tokenizer_ve.bytes_to_unicode
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.tokenizer_ve.get_pairs
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.tokenizer_ve.basic_clean
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.tokenizer_ve.whitespace_clean
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.tokenizer_ve._clean_canonicalize
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.tokenizer_ve._clean_lower
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.tokenizer_ve._clean_whitespace
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.tokenizer_ve.get_clean_fn
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.tokenizer_ve.canonicalize_text
<br><br>

View File

@@ -0,0 +1,24 @@
---
description: Explore the ultralytics.models.sam.sam3.vitdet module for ViTDet building blocks used as vision backbones in SAM3.
keywords: Ultralytics, SAM3, ViTDet, vision transformer, backbone, attention, deep learning, Python
---
# Reference for `ultralytics/models/sam/sam3/vitdet.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/sam3/vitdet.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/sam3/vitdet.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.sam.sam3.vitdet.Attention
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.vitdet.Block
<br><br><hr><br>
## ::: ultralytics.models.sam.sam3.vitdet.ViT
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Explore the ultralytics.models.sam.sam3.vl_combiner module for combining vision and language features in SAM3.
keywords: Ultralytics, SAM3, vision-language, backbone, feature fusion, transformer, deep learning, Python
---
# Reference for `ultralytics/models/sam/sam3/vl_combiner.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/sam3/vl_combiner.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/sam3/vl_combiner.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.sam.sam3.vl_combiner.SAM3VLBackbone
<br><br>

View File

@@ -0,0 +1,20 @@
---
description: Explore detailed implementations of loss functions for DETR and RT-DETR models in Ultralytics.
keywords: ultralytics, YOLO, DETR, RT-DETR, loss functions, object detection, deep learning, focal loss, varifocal loss, Hungarian matcher
---
# Reference for `ultralytics/models/utils/loss.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/utils/loss.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/utils/loss.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.utils.loss.DETRLoss
<br><br><hr><br>
## ::: ultralytics.models.utils.loss.RTDETRDetectionLoss
<br><br>

View File

@@ -0,0 +1,20 @@
---
description: Explore the utilities and operations in Ultralytics models like HungarianMatcher and get_cdn_group. Learn how to optimize and manage model operations efficiently.
keywords: Ultralytics, models, utils, operations, HungarianMatcher, get_cdn_group, model optimization, pytorch, machine learning
---
# Reference for `ultralytics/models/utils/ops.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/utils/ops.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/utils/ops.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.utils.ops.HungarianMatcher
<br><br><hr><br>
## ::: ultralytics.models.utils.ops.get_cdn_group
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Learn about the ClassificationPredictor class for YOLO models at Ultralytics. Get details on initialization, preprocessing, and postprocessing for classification tasks.
keywords: YOLO, ClassificationPredictor, Ultralytics, model prediction, preprocess, postprocess, deep learning, machine learning
---
# Reference for `ultralytics/models/yolo/classify/predict.py`
!!! success "Improvements"
This page is sourced from [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). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.yolo.classify.predict.ClassificationPredictor
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Explore the train.py module in Ultralytics YOLO for efficient classification model training. Learn more with examples and detailed code documentation.
keywords: YOLO, Ultralytics, classification, training, machine learning, deep learning, PyTorch, train.py
---
# Reference for `ultralytics/models/yolo/classify/train.py`
!!! success "Improvements"
This page is sourced from [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). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.yolo.classify.train.ClassificationTrainer
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Explore the source code and functionalities of the YOLO Classification Validator in Ultralytics for evaluating classification models effectively.
keywords: Ultralytics, YOLO, classification, validation, ClassifyMetrics, ConfusionMatrix, PyTorch, deep learning, model evaluation, AI, machine learning
---
# Reference for `ultralytics/models/yolo/classify/val.py`
!!! success "Improvements"
This page is sourced from [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). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.yolo.classify.val.ClassificationValidator
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Explore the Ultralytics YOLO Detection Predictor. Learn how to implement and use the DetectionPredictor class for object detection in Python.
keywords: YOLO, Ultralytics, DetectionPredictor, object detection, Python, machine learning, AI, non_max_suppression
---
# Reference for `ultralytics/models/yolo/detect/predict.py`
!!! success "Improvements"
This page is sourced from [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). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.yolo.detect.predict.DetectionPredictor
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Learn about the DetectionTrainer class for training YOLO models on custom datasets. Discover methods, examples, and more.
keywords: Ultralytics, YOLO, DetectionTrainer, training, object detection, machine learning, build dataset, dataloader, detection model
---
# Reference for `ultralytics/models/yolo/detect/train.py`
!!! success "Improvements"
This page is sourced from [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). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.yolo.detect.train.DetectionTrainer
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Explore the DetectionValidator class for YOLO models in Ultralytics. Learn validation techniques, metrics, and dataset handling for object detection.
keywords: YOLO validation, detection validation, YOLO metrics, Ultralytics, object detection, machine learning, AI
---
# Reference for `ultralytics/models/yolo/detect/val.py`
!!! success "Improvements"
This page is sourced from [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). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.yolo.detect.val.DetectionValidator
<br><br>

View File

@@ -0,0 +1,24 @@
---
description: Explore the ultralytics.models.yolo.model module for YOLO object detection. Learn initialization, model mapping, and more.
keywords: YOLO, object detection, Ultralytics, YOLO model, machine learning, Python, model initialization
---
# Reference for `ultralytics/models/yolo/model.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/model.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/model.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.yolo.model.YOLO
<br><br><hr><br>
## ::: ultralytics.models.yolo.model.YOLOWorld
<br><br><hr><br>
## ::: ultralytics.models.yolo.model.YOLOE
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Learn how to use the Ultralytics YOLO OBBPredictor for oriented bounding box predictions. Enhance your object detection models with ease.
keywords: Ultralytics, YOLO, OBBPredictor, oriented bounding box, object detection, AI, machine learning, PyTorch
---
# Reference for `ultralytics/models/yolo/obb/predict.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/obb/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/obb/predict.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.yolo.obb.predict.OBBPredictor
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Explore the Ultralytics YOLO OBB Trainer class for efficient training with Oriented Bounding Box models. Learn with examples and method details.
keywords: Ultralytics, YOLO, OBB Trainer, Oriented Bounding Box, Machine Learning, Training, AI
---
# Reference for `ultralytics/models/yolo/obb/train.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/obb/train.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/obb/train.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.yolo.obb.train.OBBTrainer
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Explore the OBBValidator for YOLO, an advanced class for oriented bounding boxes (OBB). Learn initialization, processes, and evaluation methods.
keywords: Ultralytics, YOLO, OBBValidator, Oriented Bounding Boxes, DetectionValidator, validation, Python, deep learning
---
# Reference for `ultralytics/models/yolo/obb/val.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/obb/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/obb/val.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.yolo.obb.val.OBBValidator
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Learn about the PosePredictor class for YOLO model predictions on pose data. Get setup instructions, example usage, and implementation details.
keywords: YOLO, Pose Prediction, Ultralytics, PosePredictor, YOLOv8, Machine Learning, Deep Learning, Python, AI Models
---
# Reference for `ultralytics/models/yolo/pose/predict.py`
!!! success "Improvements"
This page is sourced from [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). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.yolo.pose.predict.PosePredictor
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Explore the PoseTrainer class for training pose models using YOLO from Ultralytics. Includes initialization, model configuration, and plotting methods.
keywords: PoseTrainer, YOLO, Ultralytics, pose models, training, model configuration, deep learning, machine learning, pose estimation
---
# Reference for `ultralytics/models/yolo/pose/train.py`
!!! success "Improvements"
This page is sourced from [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). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.yolo.pose.train.PoseTrainer
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Explore the PoseValidator class for YOLO models. Learn how to extend DetectionValidator for pose validation with example code and detailed methods.
keywords: Ultralytics, YOLO, PoseValidator, pose validation, machine learning, object detection, keypoints, python code, AI, deep learning
---
# Reference for `ultralytics/models/yolo/pose/val.py`
!!! success "Improvements"
This page is sourced from [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). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.yolo.pose.val.PoseValidator
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Understand the SegmentationPredictor class for segmentation-based predictions using YOLO. Learn more about its implementation and example usage.
keywords: YOLO, SegmentationPredictor, machine learning, computer vision, object detection, Ultralytics, prediction, model, non-max suppression
---
# Reference for `ultralytics/models/yolo/segment/predict.py`
!!! success "Improvements"
This page is sourced from [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). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.yolo.segment.predict.SegmentationPredictor
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Learn how to train YOLO models for segmentation tasks with Ultralytics. Explore the SegmentationTrainer class and its functionalities.
keywords: YOLO, segmentation, train, Ultralytics, SegmentationTrainer, Python, machine learning, deep learning, tutorials
---
# Reference for `ultralytics/models/yolo/segment/train.py`
!!! success "Improvements"
This page is sourced from [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). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.yolo.segment.train.SegmentationTrainer
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Explore the YOLO Segmentation Validator module for validating segment models. Understand its usage, metrics, and implementation within the Ultralytics framework.
keywords: YOLO, segmentation, validator, Ultralytics, model validation, machine learning, deep learning, AI, computer vision
---
# Reference for `ultralytics/models/yolo/segment/val.py`
!!! success "Improvements"
This page is sourced from [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). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.yolo.segment.val.SegmentationValidator
<br><br>

View File

@@ -0,0 +1,20 @@
---
description: Learn how to train a World Model with Ultralytics YOLO using advanced techniques and customizable options for optimal performance.
keywords: Ultralytics, YOLO, World Model, training, deep learning, computer vision, AI, machine learning, tutorial
---
# Reference for `ultralytics/models/yolo/world/train.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/world/train.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/world/train.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.yolo.world.train.WorldTrainer
<br><br><hr><br>
## ::: ultralytics.models.yolo.world.train.on_pretrain_routine_end
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Explore the WorldTrainerFromScratch in YOLO for open-set datasets. Learn how to build, train, and evaluate models efficiently.
keywords: YOLO, WorldTrainer, open-set datasets, training, evaluation, build dataset, YOLO World, machine learning
---
# Reference for `ultralytics/models/yolo/world/train_world.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/world/train_world.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/world/train_world.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.yolo.world.train_world.WorldTrainerFromScratch
<br><br>

View File

@@ -0,0 +1,20 @@
---
description: Documentation for YOLOE visual prompt predictors in Ultralytics, supporting inference with visual prompts for both object detection and segmentation models.
keywords: YOLOE, visual prompts, predictors, YOLOEVPDetectPredictor, YOLOEVPSegPredictor, inference, object detection, segmentation, Ultralytics, deep learning
---
# Reference for `ultralytics/models/yolo/yoloe/predict.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/yoloe/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/yoloe/predict.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.yolo.yoloe.predict.YOLOEVPDetectPredictor
<br><br><hr><br>
## ::: ultralytics.models.yolo.yoloe.predict.YOLOEVPSegPredictor
<br><br>

View File

@@ -0,0 +1,32 @@
---
description: Learn about YOLOE training classes in Ultralytics, including standard, linear probing, and visual prompt training for detection and segmentation models.
keywords: YOLOE, training, trainers, EVP, visual prompts, computer vision, object detection, segmentation, Ultralytics, deep learning
---
# Reference for `ultralytics/models/yolo/yoloe/train.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/yoloe/train.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/yoloe/train.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.yolo.yoloe.train.YOLOETrainer
<br><br><hr><br>
## ::: ultralytics.models.yolo.yoloe.train.YOLOEPETrainer
<br><br><hr><br>
## ::: ultralytics.models.yolo.yoloe.train.YOLOETrainerFromScratch
<br><br><hr><br>
## ::: ultralytics.models.yolo.yoloe.train.YOLOEPEFreeTrainer
<br><br><hr><br>
## ::: ultralytics.models.yolo.yoloe.train.YOLOEVPTrainer
<br><br>

View File

@@ -0,0 +1,28 @@
---
description: Documentation for YOLOE segmentation trainer classes in Ultralytics, supporting different training approaches including standard training, linear probing, training from scratch, and visual prompt training.
keywords: YOLOE, segmentation, trainers, YOLOESegTrainer, YOLOEPESegTrainer, YOLOESegTrainerFromScratch, YOLOESegVPTrainer, linear probing, visual prompts, Ultralytics, deep learning
---
# Reference for `ultralytics/models/yolo/yoloe/train_seg.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/yoloe/train_seg.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/yoloe/train_seg.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.yolo.yoloe.train_seg.YOLOESegTrainer
<br><br><hr><br>
## ::: ultralytics.models.yolo.yoloe.train_seg.YOLOEPESegTrainer
<br><br><hr><br>
## ::: ultralytics.models.yolo.yoloe.train_seg.YOLOESegTrainerFromScratch
<br><br><hr><br>
## ::: ultralytics.models.yolo.yoloe.train_seg.YOLOESegVPTrainer
<br><br>

View File

@@ -0,0 +1,20 @@
---
description: Documentation for YOLOE validator classes in Ultralytics, supporting both text and visual prompt embeddings for object detection and segmentation models.
keywords: YOLOE, validation, object detection, segmentation, visual prompts, text prompts, embeddings, Ultralytics, YOLOEDetectValidator, YOLOESegValidator, deep learning
---
# Reference for `ultralytics/models/yolo/yoloe/val.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/yoloe/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/yoloe/val.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.models.yolo.yoloe.val.YOLOEDetectValidator
<br><br><hr><br>
## ::: ultralytics.models.yolo.yoloe.val.YOLOESegValidator
<br><br>

View File

@@ -0,0 +1,24 @@
---
description: Get to know more about Ultralytics nn.autobackend.check_class_names functionality. Optimize your YOLO models seamlessly.
keywords: Ultralytics, AutoBackend, check_class_names, YOLO, YOLO models, optimization
---
# Reference for `ultralytics/nn/autobackend.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/autobackend.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/autobackend.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.nn.autobackend.AutoBackend
<br><br><hr><br>
## ::: ultralytics.nn.autobackend.check_class_names
<br><br><hr><br>
## ::: ultralytics.nn.autobackend.default_class_names
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Explore activation functions in Ultralytics, including the Unified activation function and other custom implementations for neural networks.
keywords: ultralytics, activation functions, neural networks, Unified activation, AGLU, SiLU, ReLU, PyTorch, deep learning, custom activations
---
# Reference for `ultralytics/nn/modules/activation.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/activation.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/activation.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.nn.modules.activation.AGLU
<br><br>

View File

@@ -0,0 +1,228 @@
---
description: Explore detailed documentation of block modules in Ultralytics, available for deep learning tasks. Contribute and improve the codebase.
keywords: Ultralytics, YOLO, neural networks, block modules, DFL, Proto, HGStem, HGBlock, SPP, SPPF, C1, C2, C2f, C3, C3x, RepC3, C3TR, C3Ghost, GhostBottleneck, Bottleneck, BottleneckCSP, ResNetBlock, MaxSigmoidAttnBlock, ImagePoolingAttn, ContrastiveHead, RepBottleneck, RepCSP, RepNCSPELAN4, ADown, SPPELAN, Silence, CBLinear, CBFuse
---
# Reference for `ultralytics/nn/modules/block.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/block.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/block.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.nn.modules.block.DFL
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.Proto
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.HGStem
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.HGBlock
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.SPP
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.SPPF
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C1
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C2
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C2f
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C3
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C3x
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.RepC3
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C3TR
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C3Ghost
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.GhostBottleneck
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.Bottleneck
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.BottleneckCSP
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.ResNetBlock
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.ResNetLayer
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.MaxSigmoidAttnBlock
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C2fAttn
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.ImagePoolingAttn
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.ContrastiveHead
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.BNContrastiveHead
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.RepBottleneck
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.RepCSP
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.RepNCSPELAN4
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.ELAN1
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.AConv
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.ADown
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.SPPELAN
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.CBLinear
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.CBFuse
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C3f
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C3k2
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C3k
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.RepVGGDW
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.CIB
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C2fCIB
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.Attention
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.PSABlock
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.PSA
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C2PSA
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C2fPSA
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.SCDown
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.TorchVision
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.AAttn
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.ABlock
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.A2C2f
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.SwiGLUFFN
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.Residual
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.SAVPE
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.Proto26
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.RealNVP
<br><br>

View File

@@ -0,0 +1,72 @@
---
description: Explore detailed documentation on convolution modules like Conv, LightConv, GhostConv, and more used in Ultralytics models.
keywords: Ultralytics, convolution modules, Conv, LightConv, GhostConv, YOLO, deep learning, neural networks
---
# Reference for `ultralytics/nn/modules/conv.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/conv.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/conv.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.nn.modules.conv.Conv
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.Conv2
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.LightConv
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.DWConv
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.DWConvTranspose2d
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.ConvTranspose
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.Focus
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.GhostConv
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.RepConv
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.ChannelAttention
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.SpatialAttention
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.CBAM
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.Concat
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.Index
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.autopad
<br><br>

View File

@@ -0,0 +1,72 @@
---
description: Explore docs covering Ultralytics YOLO detection, pose & RTDETRDecoder. Comprehensive guides to help you understand Ultralytics nn modules.
keywords: Ultralytics, YOLO, Detection, Pose, RTDETRDecoder, nn modules, guides
---
# Reference for `ultralytics/nn/modules/head.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/head.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/head.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.nn.modules.head.Detect
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.Segment
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.Segment26
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.OBB
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.OBB26
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.Pose
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.Pose26
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.Classify
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.WorldDetect
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.LRPCHead
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.YOLOEDetect
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.YOLOESegment
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.YOLOESegment26
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.RTDETRDecoder
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.v10Detect
<br><br>

View File

@@ -0,0 +1,52 @@
---
description: Learn about Ultralytics transformer encoder, layer, MLP block, LayerNorm2d and the deformable transformer decoder layer. Expand your understanding of these crucial AI modules.
keywords: Ultralytics, Ultralytics documentation, TransformerEncoderLayer, TransformerLayer, MLPBlock, LayerNorm2d, DeformableTransformerDecoderLayer
---
# Reference for `ultralytics/nn/modules/transformer.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/transformer.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/transformer.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.nn.modules.transformer.TransformerEncoderLayer
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.AIFI
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.TransformerLayer
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.TransformerBlock
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.MLPBlock
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.MLP
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.LayerNorm2d
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.MSDeformAttn
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.DeformableTransformerDecoderLayer
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.DeformableTransformerDecoder
<br><br>

View File

@@ -0,0 +1,32 @@
---
description: Explore the detailed reference of utility functions in the Ultralytics PyTorch modules. Learn about initialization, inverse sigmoid, and multiscale deformable attention.
keywords: Ultralytics, PyTorch, utils, initialization, inverse sigmoid, multiscale deformable attention, deep learning, neural networks
---
# Reference for `ultralytics/nn/modules/utils.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/utils.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.nn.modules.utils._get_clones
<br><br><hr><br>
## ::: ultralytics.nn.modules.utils.bias_init_with_prob
<br><br><hr><br>
## ::: ultralytics.nn.modules.utils.linear_init
<br><br><hr><br>
## ::: ultralytics.nn.modules.utils.inverse_sigmoid
<br><br><hr><br>
## ::: ultralytics.nn.modules.utils.multi_scale_deformable_attn_pytorch
<br><br>

View File

@@ -0,0 +1,92 @@
---
description: Dive into the intricacies of YOLO tasks.py. Learn about DetectionModel, PoseModel and more for powerful AI development.
keywords: Ultralytics, YOLO, nn tasks, DetectionModel, PoseModel, RTDETRDetectionModel, model weights, parse model, AI development
---
# Reference for `ultralytics/nn/tasks.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/tasks.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/tasks.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.nn.tasks.BaseModel
<br><br><hr><br>
## ::: ultralytics.nn.tasks.DetectionModel
<br><br><hr><br>
## ::: ultralytics.nn.tasks.OBBModel
<br><br><hr><br>
## ::: ultralytics.nn.tasks.SegmentationModel
<br><br><hr><br>
## ::: ultralytics.nn.tasks.PoseModel
<br><br><hr><br>
## ::: ultralytics.nn.tasks.ClassificationModel
<br><br><hr><br>
## ::: ultralytics.nn.tasks.RTDETRDetectionModel
<br><br><hr><br>
## ::: ultralytics.nn.tasks.WorldModel
<br><br><hr><br>
## ::: ultralytics.nn.tasks.YOLOEModel
<br><br><hr><br>
## ::: ultralytics.nn.tasks.YOLOESegModel
<br><br><hr><br>
## ::: ultralytics.nn.tasks.Ensemble
<br><br><hr><br>
## ::: ultralytics.nn.tasks.SafeClass
<br><br><hr><br>
## ::: ultralytics.nn.tasks.SafeUnpickler
<br><br><hr><br>
## ::: ultralytics.nn.tasks.temporary_modules
<br><br><hr><br>
## ::: ultralytics.nn.tasks.torch_safe_load
<br><br><hr><br>
## ::: ultralytics.nn.tasks.load_checkpoint
<br><br><hr><br>
## ::: ultralytics.nn.tasks.parse_model
<br><br><hr><br>
## ::: ultralytics.nn.tasks.yaml_model_load
<br><br><hr><br>
## ::: ultralytics.nn.tasks.guess_model_scale
<br><br><hr><br>
## ::: ultralytics.nn.tasks.guess_model_task
<br><br>

View File

@@ -0,0 +1,32 @@
---
description: Documentation for text encoding models in Ultralytics YOLOE, supporting both OpenAI CLIP and Apple MobileCLIP implementations for vision-language tasks.
keywords: YOLOE, text encoding, CLIP, MobileCLIP, TextModel, vision-language models, embeddings, Ultralytics, deep learning
---
# Reference for `ultralytics/nn/text_model.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/text_model.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/text_model.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.nn.text_model.TextModel
<br><br><hr><br>
## ::: ultralytics.nn.text_model.CLIP
<br><br><hr><br>
## ::: ultralytics.nn.text_model.MobileCLIP
<br><br><hr><br>
## ::: ultralytics.nn.text_model.MobileCLIPTS
<br><br><hr><br>
## ::: ultralytics.nn.text_model.build_text_model
<br><br>

View File

@@ -0,0 +1,28 @@
---
description: Explore Ultralytics Muon optimizer with Newton-Schulz orthogonalization for neural network training. Includes MuSGD hybrid optimizer and momentum-based updates.
keywords: Muon optimizer, MuSGD, Newton-Schulz iteration, orthogonalization, momentum optimizer, neural network training, PyTorch optimizer, Ultralytics optimization
---
# Reference for `ultralytics/optim/muon.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/optim/muon.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/optim/muon.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.optim.muon.MuSGD
<br><br><hr><br>
## ::: ultralytics.optim.muon.Muon
<br><br><hr><br>
## ::: ultralytics.optim.muon.zeropower_via_newtonschulz5
<br><br><hr><br>
## ::: ultralytics.optim.muon.muon_update
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Explore the AI Gym class for real-time pose detection and gym step counting using Ultralytics YOLO. Learn to implement pose estimation effectively.
keywords: Ultralytics, AI Gym, YOLO, pose detection, gym step counting, real-time pose estimation, Python
---
# Reference for `ultralytics/solutions/ai_gym.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/ai_gym.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/ai_gym.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.solutions.ai_gym.AIGym
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Explore the Analytics class in Ultralytics for visual analytics. Learn to create and update line, bar, and pie charts efficiently.
keywords: Ultralytics, Analytics, Python, visual analytics, line chart, bar chart, pie chart, data visualization, AGPL-3.0 license
---
# Reference for `ultralytics/solutions/analytics.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/analytics.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/analytics.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.solutions.analytics.Analytics
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Configure and customize Ultralytics Vision AI solutions using the SolutionConfig class. Define model paths, regions of interest, visualization options, tracking parameters, and keypoint analytics with a clean, type-safe dataclass structure for scalable development.
keywords: Ultralytics, SolutionConfig, vision AI configuration, YOLO models, Python dataclass, object detection, region of interest, tracking, keypoint analytics, computer vision, model inference, object counting, heatmaps, parking management, research
---
# Reference for `ultralytics/solutions/config.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/config.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/config.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.solutions.config.SolutionConfig
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Explore the Ultralytics distance calculation module. Learn to calculate distances between objects in real-time video streams with our comprehensive guide.
keywords: Ultralytics, distance calculation, object tracking, real-time video, centroid, distance estimation, YOLO, ML, cv2
---
# Reference for `ultralytics/solutions/distance_calculation.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/distance_calculation.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/distance_calculation.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.solutions.distance_calculation.DistanceCalculation
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Learn how to use the Ultralytics Heatmap module for real-time video analysis with object tracking and heatmap generation.
keywords: Ultralytics, Heatmap, Python, Real-time Video, Object Tracking, cv2, Shapely, Computer Vision, AI
---
# Reference for `ultralytics/solutions/heatmap.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/heatmap.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/heatmap.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.solutions.heatmap.Heatmap
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: This page provides a detailed reference for the InstanceSegmentation class in the Ultralytics solutions package, enabling instance segmentation in images and videos.
keywords: Ultralytics, InstanceSegmentation, instance segmentation, masks, Python, computer vision
---
# Reference for `ultralytics/solutions/instance_segmentation.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/instance_segmentation.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/instance_segmentation.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.solutions.instance_segmentation.InstanceSegmentation
<br><br>

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