lichen/ieemoo-ai-gift
1
0
Fork 0
mirror of https://gitee.com/nanjing-yimao-information/ieemoo-ai-gift.git synced 2025-08-23 23:50:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

update

Browse Source
This commit is contained in:
lee
2025-06-18 14:35:43 +08:00
commit e474ab5f9f
529 changed files with 80523 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
docs/en/reference/cfg/__init__.md Normal file
View File

@ -0,0 +1,68 @@
---
description: Explore Ultralytics cfg functions like cfg2dict, handle_deprecation, merge_equal_args & more to handle YOLO settings and configurations efficiently.
keywords: Ultralytics, YOLO, Configuration, cfg2dict, handle_deprecation, merge_equals_args, handle_yolo_settings, copy_default_cfg, Image Detection
---
# Reference for `ultralytics/cfg/__init__.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/__init__.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/__init__.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/cfg/__init__.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.cfg.cfg2dict
<br><br>
## ::: ultralytics.cfg.get_cfg
<br><br>
## ::: ultralytics.cfg.check_cfg
<br><br>
## ::: ultralytics.cfg.get_save_dir
<br><br>
## ::: ultralytics.cfg._handle_deprecation
<br><br>
## ::: ultralytics.cfg.check_dict_alignment
<br><br>
## ::: ultralytics.cfg.merge_equals_args
<br><br>
## ::: ultralytics.cfg.handle_yolo_hub
<br><br>
## ::: ultralytics.cfg.handle_yolo_settings
<br><br>
## ::: ultralytics.cfg.handle_explorer
<br><br>
## ::: ultralytics.cfg.parse_key_value_pair
<br><br>
## ::: ultralytics.cfg.smart_value
<br><br>
## ::: ultralytics.cfg.entrypoint
<br><br>
## ::: ultralytics.cfg.copy_default_cfg
<br><br>

16
docs/en/reference/data/annotator.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Enhance your machine learning model with Ultralytics’ auto_annotate function. Simplify data annotation for improved model training.
keywords: Ultralytics, Auto-Annotate, Machine Learning, AI, Annotation, Data Processing, Model Training
---
# Reference for `ultralytics/data/annotator.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/annotator.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/annotator.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/annotator.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.data.annotator.auto_annotate
<br><br>

84
docs/en/reference/data/augment.md Normal file
View File

@ -0,0 +1,84 @@
---
description: Detailed exploration into Ultralytics data augmentation methods including BaseTransform, MixUp, LetterBox, ToTensor, and more for enhancing model performance.
keywords: Ultralytics, Data Augmentation, BaseTransform, MixUp, RandomHSV, LetterBox, Albumentations, classify_transforms, classify_albumentations
---
# Reference for `ultralytics/data/augment.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/augment.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/augment.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/augment.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.data.augment.BaseTransform
<br><br>
## ::: ultralytics.data.augment.Compose
<br><br>
## ::: ultralytics.data.augment.BaseMixTransform
<br><br>
## ::: ultralytics.data.augment.Mosaic
<br><br>
## ::: ultralytics.data.augment.MixUp
<br><br>
## ::: ultralytics.data.augment.RandomPerspective
<br><br>
## ::: ultralytics.data.augment.RandomHSV
<br><br>
## ::: ultralytics.data.augment.RandomFlip
<br><br>
## ::: ultralytics.data.augment.LetterBox
<br><br>
## ::: ultralytics.data.augment.CopyPaste
<br><br>
## ::: ultralytics.data.augment.Albumentations
<br><br>
## ::: ultralytics.data.augment.Format
<br><br>
## ::: ultralytics.data.augment.ClassifyLetterBox
<br><br>
## ::: ultralytics.data.augment.CenterCrop
<br><br>
## ::: ultralytics.data.augment.ToTensor
<br><br>
## ::: ultralytics.data.augment.v8_transforms
<br><br>
## ::: ultralytics.data.augment.classify_transforms
<br><br>
## ::: ultralytics.data.augment.classify_augmentations
<br><br>

16
docs/en/reference/data/base.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Explore BaseDataset in Ultralytics docs. Learn how this implementation simplifies dataset creation and manipulation.
keywords: Ultralytics, docs, BaseDataset, data manipulation, dataset creation
---
# Reference for `ultralytics/data/base.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/base.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/base.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/base.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.data.base.BaseDataset
<br><br>

40
docs/en/reference/data/build.md Normal file
View File

@ -0,0 +1,40 @@
---
description: Explore the Ultralytics YOLO v3 data build procedures, including the InfiniteDataLoader, seed_worker, build_dataloader, and load_inference_source.
keywords: Ultralytics, YOLO v3, Data build, DataLoader, InfiniteDataLoader, seed_worker, build_dataloader, load_inference_source
---
# Reference for `ultralytics/data/build.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/build.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/build.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/build.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.data.build.InfiniteDataLoader
<br><br>
## ::: ultralytics.data.build._RepeatSampler
<br><br>
## ::: ultralytics.data.build.seed_worker
<br><br>
## ::: ultralytics.data.build.build_yolo_dataset
<br><br>
## ::: ultralytics.data.build.build_dataloader
<br><br>
## ::: ultralytics.data.build.check_source
<br><br>
## ::: ultralytics.data.build.load_inference_source
<br><br>

40
docs/en/reference/data/converter.md Normal file
View File

@ -0,0 +1,40 @@
---
description: Explore Ultralytics data converter functions like coco91_to_coco80_class, merge_multi_segment, rle2polygon for efficient data handling.
keywords: Ultralytics, Data Converter, coco91_to_coco80_class, merge_multi_segment, rle2polygon
---
# Reference for `ultralytics/data/converter.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/converter.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/converter.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/converter.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.data.converter.coco91_to_coco80_class
<br><br>
## ::: ultralytics.data.converter.coco80_to_coco91_class
<br><br>
## ::: ultralytics.data.converter.convert_coco
<br><br>
## ::: ultralytics.data.converter.convert_dota_to_yolo_obb
<br><br>
## ::: ultralytics.data.converter.min_index
<br><br>
## ::: ultralytics.data.converter.merge_multi_segment
<br><br>
## ::: ultralytics.data.converter.yolo_bbox2segment
<br><br>

32
docs/en/reference/data/dataset.md Normal file
View File

@ -0,0 +1,32 @@
---
description: Explore the YOLODataset and SemanticDataset classes in YOLO data. Learn how to efficiently handle and manipulate your data with Ultralytics.
keywords: Ultralytics, YOLO, YOLODataset, SemanticDataset, data handling, data manipulation
---
# Reference for `ultralytics/data/dataset.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/dataset.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/dataset.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/dataset.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.data.dataset.YOLODataset
<br><br>
## ::: ultralytics.data.dataset.ClassificationDataset
<br><br>
## ::: ultralytics.data.dataset.SemanticDataset
<br><br>
## ::: ultralytics.data.dataset.load_dataset_cache_file
<br><br>
## ::: ultralytics.data.dataset.save_dataset_cache_file
<br><br>

21
docs/en/reference/data/explorer/explorer.md Normal file
View File

@ -0,0 +1,21 @@
---
comments: true
description: Comprehensive reference for the Explorer API. Get a brief description of all the main classes utilised for creating and handling the data in the Ultralytics data explorer project.
keywords: Ultralytics, explorer.py, data explorer, Semantic search, vector similarity search, class reference, documentation, ExplorerDataset, Explorer, data handling
---
# Reference for `ultralytics/data/explorer/explorer.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/explorer/explorer.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/explorer/explorer.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/explorer/explorer.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.data.explorer.explorer.ExplorerDataset
<br><br>
## ::: ultralytics.data.explorer.explorer.Explorer
<br><br>

57
docs/en/reference/data/explorer/gui/dash.md Normal file
View File

@ -0,0 +1,57 @@
---
comments: true
description: Detailed reference for the Explorer GUI. Includes brief descriptions for all the major functions used in the dashboard demo of Explorer API.
keywords: Ultralytics, data explorer, gui, function reference, documentation, AI queries, image similarity, SQL queries, streamlit, semantic search
---
# Reference for `ultralytics/data/explorer/gui/dash.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/explorer/gui/dash.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/explorer/gui/dash.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/explorer/gui/dash.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.data.explorer.gui.dash._get_explorer
<br><br>
## ::: ultralytics.data.explorer.gui.dash.init_explorer_form
<br><br>
## ::: ultralytics.data.explorer.gui.dash.query_form
<br><br>
## ::: ultralytics.data.explorer.gui.dash.ai_query_form
<br><br>
## ::: ultralytics.data.explorer.gui.dash.find_similar_imgs
<br><br>
## ::: ultralytics.data.explorer.gui.dash.similarity_form
<br><br>
## ::: ultralytics.data.explorer.gui.dash.run_sql_query
<br><br>
## ::: ultralytics.data.explorer.gui.dash.run_ai_query
<br><br>
## ::: ultralytics.data.explorer.gui.dash.reset_explorer
<br><br>
## ::: ultralytics.data.explorer.gui.dash.utralytics_explorer_docs_callback
<br><br>
## ::: ultralytics.data.explorer.gui.dash.layout
<br><br>

33
docs/en/reference/data/explorer/utils.md Normal file
View File

@ -0,0 +1,33 @@
---
comments: true
description: Detailed reference for the Explorer utils. Provides descriptions and details on important utility functions for managing and interacting with data in the Ultralytics explorer project.
keywords: Ultralytics, data explorer, function reference, documentation, get table schema, get sim index schema, sanitize batch, plot query result, prompt SQL query
---
# Reference for `ultralytics/data/explorer/utils.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/explorer/utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/explorer/utils.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/explorer/utils.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.data.explorer.utils.get_table_schema
<br><br>
## ::: ultralytics.data.explorer.utils.get_sim_index_schema
<br><br>
## ::: ultralytics.data.explorer.utils.sanitize_batch
<br><br>
## ::: ultralytics.data.explorer.utils.plot_query_result
<br><br>
## ::: ultralytics.data.explorer.utils.prompt_sql_query
<br><br>

44
docs/en/reference/data/loaders.md Normal file
View File

@ -0,0 +1,44 @@
---
description: Find detailed guides on Ultralytics YOLO data loaders, including LoadStreams, LoadImages and LoadTensor. Learn how to get the best YouTube URLs.
keywords: Ultralytics, data loaders, LoadStreams, LoadImages, LoadTensor, YOLO, YouTube URLs
---
# Reference for `ultralytics/data/loaders.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/loaders.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/loaders.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/loaders.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.data.loaders.SourceTypes
<br><br>
## ::: ultralytics.data.loaders.LoadStreams
<br><br>
## ::: ultralytics.data.loaders.LoadScreenshots
<br><br>
## ::: ultralytics.data.loaders.LoadImagesAndVideos
<br><br>
## ::: ultralytics.data.loaders.LoadPilAndNumpy
<br><br>
## ::: ultralytics.data.loaders.LoadTensor
<br><br>
## ::: ultralytics.data.loaders.autocast_list
<br><br>
## ::: ultralytics.data.loaders.get_best_youtube_url
<br><br>

44
docs/en/reference/data/split_dota.md Normal file
View File

@ -0,0 +1,44 @@
---
description: Detailed guide on using YOLO with DOTA dataset for object detection, including dataset preparation, image splitting, and label handling.
keywords: Ultralytics, YOLO, DOTA dataset, object detection, image processing, python, dataset preparation, image splitting, label handling, YOLO with DOTA, computer vision, AI, machine learning
---
# Reference for `ultralytics/data/split_dota.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/split_dota.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/split_dota.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/split_dota.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.data.split_dota.bbox_iof
<br><br>
## ::: ultralytics.data.split_dota.load_yolo_dota
<br><br>
## ::: ultralytics.data.split_dota.get_windows
<br><br>
## ::: ultralytics.data.split_dota.get_window_obj
<br><br>
## ::: ultralytics.data.split_dota.crop_and_save
<br><br>
## ::: ultralytics.data.split_dota.split_images_and_labels
<br><br>
## ::: ultralytics.data.split_dota.split_trainval
<br><br>
## ::: ultralytics.data.split_dota.split_test
<br><br>

68
docs/en/reference/data/utils.md Normal file
View File

@ -0,0 +1,68 @@
---
description: Uncover a detailed guide to Ultralytics data utilities. Learn functions from img2label_paths to autosplit, all boosting your YOLO model’s efficiency.
keywords: Ultralytics, data utils, YOLO, img2label_paths, exif_size, polygon2mask, polygons2masks_overlap, check_cls_dataset, delete_dsstore, autosplit
---
# Reference for `ultralytics/data/utils.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/utils.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/utils.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.data.utils.HUBDatasetStats
<br><br>
## ::: ultralytics.data.utils.img2label_paths
<br><br>
## ::: ultralytics.data.utils.get_hash
<br><br>
## ::: ultralytics.data.utils.exif_size
<br><br>
## ::: ultralytics.data.utils.verify_image
<br><br>
## ::: ultralytics.data.utils.verify_image_label
<br><br>
## ::: ultralytics.data.utils.polygon2mask
<br><br>
## ::: ultralytics.data.utils.polygons2masks
<br><br>
## ::: ultralytics.data.utils.polygons2masks_overlap
<br><br>
## ::: ultralytics.data.utils.find_dataset_yaml
<br><br>
## ::: ultralytics.data.utils.check_det_dataset
<br><br>
## ::: ultralytics.data.utils.check_cls_dataset
<br><br>
## ::: ultralytics.data.utils.compress_one_image
<br><br>
## ::: ultralytics.data.utils.autosplit
<br><br>

32
docs/en/reference/engine/exporter.md Normal file
View File

@ -0,0 +1,32 @@
---
description: Explore the exporter functionality of Ultralytics. Learn about exporting formats, IOSDetectModel, and try exporting with examples.
keywords: Ultralytics, Exporter, IOSDetectModel, Export Formats, Try export
---
# Reference for `ultralytics/engine/exporter.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/exporter.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/exporter.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/engine/exporter.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.engine.exporter.Exporter
<br><br>
## ::: ultralytics.engine.exporter.IOSDetectModel
<br><br>
## ::: ultralytics.engine.exporter.export_formats
<br><br>
## ::: ultralytics.engine.exporter.gd_outputs
<br><br>
## ::: ultralytics.engine.exporter.try_export
<br><br>

16
docs/en/reference/engine/model.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Explore the detailed guide on using the Ultralytics YOLO Engine Model. Learn better ways to implement, train and evaluate YOLO models.
keywords: Ultralytics, YOLO, engine model, documentation, guide, implementation, training, evaluation
---
# Reference for `ultralytics/engine/model.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/model.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/model.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/engine/model.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.engine.model.Model
<br><br>

16
docs/en/reference/engine/predictor.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Learn about Ultralytics BasePredictor, an essential component of our engine that serves as the foundation for all prediction operations.
keywords: Ultralytics, BasePredictor, YOLO, prediction, engine
---
# Reference for `ultralytics/engine/predictor.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/predictor.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/predictor.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/engine/predictor.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.engine.predictor.BasePredictor
<br><br>

40
docs/en/reference/engine/results.md Normal file
View File

@ -0,0 +1,40 @@
---
description: Master Ultralytics engine results including base tensors, boxes, and keypoints with our thorough documentation.
keywords: Ultralytics, engine, results, base tensor, boxes, keypoints
---
# Reference for `ultralytics/engine/results.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/results.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/results.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/engine/results.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.engine.results.BaseTensor
<br><br>
## ::: ultralytics.engine.results.Results
<br><br>
## ::: ultralytics.engine.results.Boxes
<br><br>
## ::: ultralytics.engine.results.Masks
<br><br>
## ::: ultralytics.engine.results.Keypoints
<br><br>
## ::: ultralytics.engine.results.Probs
<br><br>
## ::: ultralytics.engine.results.OBB
<br><br>

16
docs/en/reference/engine/trainer.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Learn about the BaseTrainer class in the Ultralytics library. From training control, customization to advanced usage.
keywords: Ultralytics, BaseTrainer, Machine Learning, Training Control, Python library
---
# Reference for `ultralytics/engine/trainer.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/trainer.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/trainer.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/engine/trainer.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.engine.trainer.BaseTrainer
<br><br>

16
docs/en/reference/engine/tuner.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Explore the Ultralytics Tuner, a powerful tool designed for hyperparameter tuning of YOLO models to optimize performance across various tasks like object detection, image classification, and more.
keywords: Ultralytics, Tuner, YOLO, hyperparameter tuning, optimization, object detection, image classification, instance segmentation, pose estimation, multi-object tracking
---
# Reference for `ultralytics/engine/tuner.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/tuner.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/tuner.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/engine/tuner.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.engine.tuner.Tuner
<br><br>

16
docs/en/reference/engine/validator.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Learn about the Ultralytics BaseValidator module. Understand its principles, uses, and how it interacts with other components.
keywords: Ultralytics, BaseValidator, Ultralytics engine, module, components
---
# Reference for `ultralytics/engine/validator.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/validator.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/validator.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/engine/validator.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.engine.validator.BaseValidator
<br><br>

40
docs/en/reference/hub/__init__.md Normal file
View File

@ -0,0 +1,40 @@
---
description: Explore Ultralytics hub functions for model resetting, checking datasets, model exporting and more. Easy-to-follow instructions provided.
keywords: Ultralytics, hub functions, model export, dataset check, reset model, YOLO Docs
---
# Reference for `ultralytics/hub/__init__.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/__init__.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/__init__.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/hub/__init__.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.hub.login
<br><br>
## ::: ultralytics.hub.logout
<br><br>
## ::: ultralytics.hub.reset_model
<br><br>
## ::: ultralytics.hub.export_fmts_hub
<br><br>
## ::: ultralytics.hub.export_model
<br><br>
## ::: ultralytics.hub.get_export
<br><br>
## ::: ultralytics.hub.check_dataset
<br><br>

16
docs/en/reference/hub/auth.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Dive into the Ultralytics Auth API documentation & learn how to manage authentication in your AI & ML projects easily and effectively.
keywords: Ultralytics, Auth, API documentation, User Authentication, AI, Machine Learning
---
# Reference for `ultralytics/hub/auth.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/auth.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/auth.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/hub/auth.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.hub.auth.Auth
<br><br>

16
docs/en/reference/hub/session.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Explore details about the HUBTrainingSession in Ultralytics framework. Learn to utilize this functionality for effective model training.
keywords: Ultralytics, HUBTrainingSession, Documentation, Model Training, AI, Machine Learning, YOLO
---
# Reference for `ultralytics/hub/session.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/session.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/session.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/hub/session.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.hub.session.HUBTrainingSession
<br><br>

28
docs/en/reference/hub/utils.md Normal file
View File

@ -0,0 +1,28 @@
---
description: Explore Ultralytics docs for various Events, including "request_with_credentials" and "requests_with_progress". Also, understand the use of the "smart_request".
keywords: Ultralytics, Events, request_with_credentials, smart_request, Ultralytics hub utils, requests_with_progress
---
# Reference for `ultralytics/hub/utils.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub/utils.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/hub/utils.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.hub.utils.Events
<br><br>
## ::: ultralytics.hub.utils.request_with_credentials
<br><br>
## ::: ultralytics.hub.utils.requests_with_progress
<br><br>
## ::: ultralytics.hub.utils.smart_request
<br><br>

16
docs/en/reference/models/fastsam/model.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Learn all about Ultralytics FastSAM model. Dive into our comprehensive guide for seamless integration and efficient model training.
keywords: Ultralytics, FastSAM model, Model documentation, Efficient model training
---
# Reference for `ultralytics/models/fastsam/model.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/model.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/model.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/fastsam/model.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.fastsam.model.FastSAM
<br><br>

16
docs/en/reference/models/fastsam/predict.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Get detailed insights about Ultralytics FastSAMPredictor. Learn to predict and optimize your AI models with our properly documented guidelines.
keywords: Ultralytics, FastSAMPredictor, predictive modeling, AI optimization, machine learning, deep learning, Ultralytics documentation
---
# Reference for `ultralytics/models/fastsam/predict.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/predict.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/fastsam/predict.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.fastsam.predict.FastSAMPredictor
<br><br>

16
docs/en/reference/models/fastsam/prompt.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Learn to effectively utilize FastSAMPrompt model from Ultralytics. Detailed guide to help you get the most out of your machine learning models.
keywords: Ultralytics, FastSAMPrompt, machine learning, model, guide, documentation
---
# Reference for `ultralytics/models/fastsam/prompt.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/prompt.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/prompt.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/fastsam/prompt.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.fastsam.prompt.FastSAMPrompt
<br><br>

20
docs/en/reference/models/fastsam/utils.md Normal file
View File

@ -0,0 +1,20 @@
---
description: Learn how to adjust bounding boxes to image borders in Ultralytics models using the bbox_iou utility. Enhance your object detection performance.
keywords: Ultralytics, bounding boxes, Bboxes, image borders, object detection, bbox_iou, model utilities
---
# Reference for `ultralytics/models/fastsam/utils.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/utils.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/fastsam/utils.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.fastsam.utils.adjust_bboxes_to_image_border
<br><br>
## ::: ultralytics.models.fastsam.utils.bbox_iou
<br><br>

16
docs/en/reference/models/fastsam/val.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Learn about FastSAMValidator in Ultralytics models. Comprehensive guide to enhancing AI capabilities with Ultralytics.
keywords: Ultralytics, FastSAMValidator, model, synthetic, AI, machine learning, validation
---
# Reference for `ultralytics/models/fastsam/val.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/val.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/fastsam/val.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.fastsam.val.FastSAMValidator
<br><br>

16
docs/en/reference/models/nas/model.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Learn how our NAS model operates in Ultralytics. Comprehensive guide with detailed examples. Master the nuances of Ultralytics NAS model.
keywords: Ultralytics, NAS model, NAS guide, machine learning, model documentation
---
# Reference for `ultralytics/models/nas/model.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/nas/model.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/nas/model.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/nas/model.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.nas.model.NAS
<br><br>

16
docs/en/reference/models/nas/predict.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Explore Ultralytics NASPredictor. Understand high-level architecture of the model for effective implementation and efficient predictions.
keywords: NASPredictor, Ultralytics, Ultralytics model, model architecture, efficient predictions
---
# Reference for `ultralytics/models/nas/predict.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/nas/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/nas/predict.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/nas/predict.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.nas.predict.NASPredictor
<br><br>

16
docs/en/reference/models/nas/val.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Explore the utilities and functions of the Ultralytics NASValidator. Find out how it benefits allocation and optimization in AI models.
keywords: Ultralytics, NASValidator, models.nas.val.NASValidator, AI models, allocation, optimization
---
# Reference for `ultralytics/models/nas/val.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/nas/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/nas/val.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/nas/val.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.nas.val.NASValidator
<br><br>

16
docs/en/reference/models/rtdetr/model.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Explore the specifics of using the RTDETR model in Ultralytics. Detailed documentation layered with explanations and examples.
keywords: Ultralytics, RTDETR model, Ultralytics models, object detection, Ultralytics documentation
---
# Reference for `ultralytics/models/rtdetr/model.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/model.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/model.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/rtdetr/model.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.rtdetr.model.RTDETR
<br><br>

16
docs/en/reference/models/rtdetr/predict.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Learn how to use the RTDETRPredictor model of the Ultralytics package. Detailed documentation, usage instructions, and advice.
keywords: Ultralytics, RTDETRPredictor, model documentation, guide, real-time object detection
---
# Reference for `ultralytics/models/rtdetr/predict.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/predict.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/rtdetr/predict.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.rtdetr.predict.RTDETRPredictor
<br><br>

16
docs/en/reference/models/rtdetr/train.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Get insights into RTDETRTrainer, a crucial component of Ultralytics for effective model training. Explore detailed documentation at Ultralytics.
keywords: Ultralytics, RTDETRTrainer, model training, Ultralytics models, PyTorch models, neural networks, machine learning, deep learning
---
# Reference for `ultralytics/models/rtdetr/train.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/train.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/train.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/rtdetr/train.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.rtdetr.train.RTDETRTrainer
<br><br>

20
docs/en/reference/models/rtdetr/val.md Normal file
View File

@ -0,0 +1,20 @@
---
description: Explore RTDETRDataset in Ultralytics Models. Learn about the RTDETRValidator function, understand its usage in real-time object detection.
keywords: Ultralytics, RTDETRDataset, RTDETRValidator, real-time object detection, models documentation
---
# Reference for `ultralytics/models/rtdetr/val.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/val.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/rtdetr/val.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.rtdetr.val.RTDETRDataset
<br><br>
## ::: ultralytics.models.rtdetr.val.RTDETRValidator
<br><br>

56
docs/en/reference/models/sam/amg.md Normal file
View File

@ -0,0 +1,56 @@
---
description: Explore Ultralytics methods for mask data processing, transformation and encoding. Deepen your understanding of RLE encoding, image cropping and more.
keywords: Ultralytics, Mask Data, Transformation, Encoding, RLE encoding, Image cropping, Pytorch, SAM, AMG, Ultralytics model
---
# Reference for `ultralytics/models/sam/amg.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/amg.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/amg.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/amg.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.sam.amg.is_box_near_crop_edge
<br><br>
## ::: ultralytics.models.sam.amg.batch_iterator
<br><br>
## ::: ultralytics.models.sam.amg.calculate_stability_score
<br><br>
## ::: ultralytics.models.sam.amg.build_point_grid
<br><br>
## ::: ultralytics.models.sam.amg.build_all_layer_point_grids
<br><br>
## ::: ultralytics.models.sam.amg.generate_crop_boxes
<br><br>
## ::: ultralytics.models.sam.amg.uncrop_boxes_xyxy
<br><br>
## ::: ultralytics.models.sam.amg.uncrop_points
<br><br>
## ::: ultralytics.models.sam.amg.uncrop_masks
<br><br>
## ::: ultralytics.models.sam.amg.remove_small_regions
<br><br>
## ::: ultralytics.models.sam.amg.batched_mask_to_box
<br><br>

36
docs/en/reference/models/sam/build.md Normal file
View File

@ -0,0 +1,36 @@
---
description: Master building SAM ViT models with Ultralytics. Discover steps to leverage the power of SAM and Vision Transformer sessions.
keywords: Ultralytics, SAM, build sam, vision transformer, vits, build_sam_vit_l, build_sam_vit_b, build_sam
---
# Reference for `ultralytics/models/sam/build.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/build.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/build.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/build.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.sam.build.build_sam_vit_h
<br><br>
## ::: ultralytics.models.sam.build.build_sam_vit_l
<br><br>
## ::: ultralytics.models.sam.build.build_sam_vit_b
<br><br>
## ::: ultralytics.models.sam.build.build_mobile_sam
<br><br>
## ::: ultralytics.models.sam.build._build_sam
<br><br>
## ::: ultralytics.models.sam.build.build_sam
<br><br>

16
docs/en/reference/models/sam/model.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Dive into the SAM model details in the Ultralytics YOLO documentation. Understand, implement, and optimize your model use.
keywords: Ultralytics, YOLO, SAM Model, Documentations, Machine Learning, AI, Convolutional neural network
---
# Reference for `ultralytics/models/sam/model.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/model.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/model.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/model.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.sam.model.SAM
<br><br>

20
docs/en/reference/models/sam/modules/decoders.md Normal file
View File

@ -0,0 +1,20 @@
---
description: Explore MaskDecoder, a part of the Ultralytics models. Gain insights on how to utilize it effectively in the SAM modules decoders MLP.
keywords: Ultralytics, MaskDecoder, SAM modules, decoders, MLP, YOLO, machine learning, image recognition
---
# Reference for `ultralytics/models/sam/modules/decoders.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/decoders.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/decoders.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/modules/decoders.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.sam.modules.decoders.MaskDecoder
<br><br>
## ::: ultralytics.models.sam.modules.decoders.MLP
<br><br>

52
docs/en/reference/models/sam/modules/encoders.md Normal file
View File

@ -0,0 +1,52 @@
---
description: Discover detailed information on ImageEncoderViT, PositionEmbeddingRandom, Attention, window_partition, get_rel_pos and more in Ultralytics models encoders documentation.
keywords: Ultralytics, Encoders, Modules, Documentation, ImageEncoderViT, PositionEmbeddingRandom, Attention, window_partition, get_rel_pos
---
# Reference for `ultralytics/models/sam/modules/encoders.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/encoders.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/encoders.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/modules/encoders.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.sam.modules.encoders.ImageEncoderViT
<br><br>
## ::: ultralytics.models.sam.modules.encoders.PromptEncoder
<br><br>
## ::: ultralytics.models.sam.modules.encoders.PositionEmbeddingRandom
<br><br>
## ::: ultralytics.models.sam.modules.encoders.Block
<br><br>
## ::: ultralytics.models.sam.modules.encoders.Attention
<br><br>
## ::: ultralytics.models.sam.modules.encoders.PatchEmbed
<br><br>
## ::: ultralytics.models.sam.modules.encoders.window_partition
<br><br>
## ::: ultralytics.models.sam.modules.encoders.window_unpartition
<br><br>
## ::: ultralytics.models.sam.modules.encoders.get_rel_pos
<br><br>
## ::: ultralytics.models.sam.modules.encoders.add_decomposed_rel_pos
<br><br>

16
docs/en/reference/models/sam/modules/sam.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Explore the Sam module of Ultralytics. Discover detailed methods, classes, and information for efficient deep-learning model training!.
keywords: Ultralytics, Sam module, deep learning, model training, Ultralytics documentation
---
# Reference for `ultralytics/models/sam/modules/sam.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/sam.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/sam.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/modules/sam.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.sam.modules.sam.Sam
<br><br>

56
docs/en/reference/models/sam/modules/tiny_encoder.md Normal file
View File

@ -0,0 +1,56 @@
---
description: Get in-depth insights about Ultralytics Tiny Encoder Modules such as Conv2d_BN, MBConv, ConvLayer, Attention, BasicLayer, and TinyViT. Improve your understanding of machine learning model components.
keywords: Ultralytics, Tiny Encoder, Conv2d_BN, MBConv, ConvLayer, Attention, BasicLayer, TinyViT, Machine learning modules, Ultralytics models
---
# Reference for `ultralytics/models/sam/modules/tiny_encoder.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/tiny_encoder.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/tiny_encoder.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/modules/tiny_encoder.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.Conv2d_BN
<br><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.PatchEmbed
<br><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.MBConv
<br><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.PatchMerging
<br><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.ConvLayer
<br><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.Mlp
<br><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.Attention
<br><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.TinyViTBlock
<br><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.BasicLayer
<br><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.LayerNorm2d
<br><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.TinyViT
<br><br>

24
docs/en/reference/models/sam/modules/transformer.md Normal file
View File

@ -0,0 +1,24 @@
---
description: Learn about TwoWayTransformer and Attention modules in Ultralytics. Leverage these tools to enhance your AI models.
keywords: Ultralytics, TwoWayTransformer, Attention, AI models, transformers
---
# Reference for `ultralytics/models/sam/modules/transformer.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/transformer.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/transformer.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/modules/transformer.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.sam.modules.transformer.TwoWayTransformer
<br><br>
## ::: ultralytics.models.sam.modules.transformer.TwoWayAttentionBlock
<br><br>
## ::: ultralytics.models.sam.modules.transformer.Attention
<br><br>

16
docs/en/reference/models/sam/predict.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Master the ultralytics.models.sam.predict.Predictor class with our comprehensive guide. Discover techniques to enhance your model predictions.
keywords: Ultralytics, predictor, models, sam.predict.Predictor, AI, machine learning, predictive models
---
# Reference for `ultralytics/models/sam/predict.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/predict.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/predict.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.sam.predict.Predictor
<br><br>

20
docs/en/reference/models/utils/loss.md Normal file
View File

@ -0,0 +1,20 @@
---
description: Learn to use the DETRLoss function provided by Ultralytics YOLO. Understand how to utilize loss in RTDETR detection models to improve accuracy.
keywords: Ultralytics, YOLO, Documentation, DETRLoss, Detection Loss, Loss function, DETR, RTDETR Detection Models
---
# Reference for `ultralytics/models/utils/loss.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/utils/loss.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/utils/loss.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/utils/loss.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.utils.loss.DETRLoss
<br><br>
## ::: ultralytics.models.utils.loss.RTDETRDetectionLoss
<br><br>

20
docs/en/reference/models/utils/ops.md Normal file
View File

@ -0,0 +1,20 @@
---
description: Discover details for "HungarianMatcher" & "inverse_sigmoid" functions in Ultralytics YOLO, advanced tools supporting detection models.
keywords: Ultralytics, YOLO, HungarianMatcher, inverse_sigmoid, detection models, model utilities, ops
---
# Reference for `ultralytics/models/utils/ops.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/utils/ops.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/utils/ops.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/utils/ops.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.utils.ops.HungarianMatcher
<br><br>
## ::: ultralytics.models.utils.ops.get_cdn_group
<br><br>

16
docs/en/reference/models/yolo/classify/predict.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Explore the Ultralytics ClassificationPredictor guide for model prediction and visualization. Build powerful AI models with YOLO.
keywords: Ultralytics, classification predictor, predict, YOLO, AI models, model visualization
---
# Reference for `ultralytics/models/yolo/classify/predict.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/classify/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/classify/predict.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/classify/predict.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.yolo.classify.predict.ClassificationPredictor
<br><br>

16
docs/en/reference/models/yolo/classify/train.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Delve into Classification Trainer at Ultralytics YOLO docs and optimize your model's training process with insights from the masters!.
keywords: Ultralytics, YOLO, Classification Trainer, deep learning, training process, AI models, documentation
---
# Reference for `ultralytics/models/yolo/classify/train.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/classify/train.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/classify/train.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/classify/train.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.yolo.classify.train.ClassificationTrainer
<br><br>

16
docs/en/reference/models/yolo/classify/val.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Explore YOLO ClassificationValidator, a key element of Ultralytics YOLO models. Learn how it validates and fine-tunes model outputs.
keywords: Ultralytics, YOLO, ClassificationValidator, model validation, model fine-tuning, deep learning, computer vision
---
# Reference for `ultralytics/models/yolo/classify/val.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/classify/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/classify/val.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/classify/val.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.yolo.classify.val.ClassificationValidator
<br><br>

16
docs/en/reference/models/yolo/detect/predict.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Explore the guide to using the DetectionPredictor in Ultralytics YOLO. Learn how to predict, detect and analyze objects accurately.
keywords: Ultralytics, YOLO, DetectionPredictor, detect, predict, object detection, analysis
---
# Reference for `ultralytics/models/yolo/detect/predict.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/detect/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/detect/predict.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/detect/predict.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.yolo.detect.predict.DetectionPredictor
<br><br>

16
docs/en/reference/models/yolo/detect/train.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Maximize your model's potential with Ultralytics YOLO Detection Trainer. Learn advanced techniques, tips, and tricks for training.
keywords: Ultralytics YOLO, YOLO, Detection Trainer, Model Training, Machine Learning, Deep Learning, Computer Vision
---
# Reference for `ultralytics/models/yolo/detect/train.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/detect/train.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/detect/train.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/detect/train.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.yolo.detect.train.DetectionTrainer
<br><br>

16
docs/en/reference/models/yolo/detect/val.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Discover function valuation of your YOLO models with the Ultralytics Detection Validator. Enhance precision and recall rates today.
keywords: Ultralytics, YOLO, Detection Validator, model valuation, precision, recall
---
# Reference for `ultralytics/models/yolo/detect/val.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/detect/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/detect/val.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/detect/val.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.yolo.detect.val.DetectionValidator
<br><br>

20
docs/en/reference/models/yolo/model.md Normal file
View File

@ -0,0 +1,20 @@
---
description: Discover the Ultralytics YOLO model class. Learn advanced techniques, tips, and tricks for training.
keywords: Ultralytics YOLO, YOLO, YOLO model, Model Training, Machine Learning, Deep Learning, Computer Vision
---
# Reference for `ultralytics/models/yolo/model.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/model.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/model.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/model.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.yolo.model.YOLO
<br><br>
## ::: ultralytics.models.yolo.model.YOLOWorld
<br><br>

16
docs/en/reference/models/yolo/obb/predict.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Discover OBBPredictor for YOLO, specializing in Oriented Bounding Box predictions. Essential for advanced object detection with Ultralytics YOLO.
keywords: Ultralytics, OBBPredictor, YOLO, Oriented Bounding Box, object detection, advanced object detection, YOLO model, deep learning, AI, machine learning, computer vision, OBB detection
---
# Reference for `ultralytics/models/yolo/obb/predict.py`
!!! Note
This file is available at [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). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/obb/predict.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.yolo.obb.predict.OBBPredictor
<br><br>

16
docs/en/reference/models/yolo/obb/train.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Master the Ultralytics YOLO OBB Trainer: A specialized tool for training YOLO models using Oriented Bounding Boxes. Features detailed usage, model initialization, and training processes.
keywords: Ultralytics, YOLO OBB Trainer, Oriented Bounding Box, OBB model training, YOLO model training, computer vision, deep learning, machine learning, YOLO object detection, model initialization, YOLO training process
---
# Reference for `ultralytics/models/yolo/obb/train.py`
!!! Note
This file is available at [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). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/obb/train.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.yolo.obb.train.OBBTrainer
<br><br>

16
docs/en/reference/models/yolo/obb/val.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Learn about Ultralytics' advanced OBBValidator, an extension of YOLO object detection for oriented bounding box validation.
keywords: Ultralytics, YOLO, OBBValidator, object detection, oriented bounding box, OBB, machine learning, AI, deep learning, Python, YOLO model, image processing, computer vision, YOLO object detection
---
# Reference for `ultralytics/models/yolo/obb/val.py`
!!! Note
This file is available at [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). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/obb/val.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.yolo.obb.val.OBBValidator
<br><br>

16
docs/en/reference/models/yolo/pose/predict.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Discover how to use PosePredictor in the Ultralytics YOLO model. Includes detailed guides, code examples, and explanations.
keywords: Ultralytics, YOLO, PosePredictor, machine learning, AI, predictive models
---
# Reference for `ultralytics/models/yolo/pose/predict.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/pose/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/pose/predict.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/pose/predict.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.yolo.pose.predict.PosePredictor
<br><br>

16
docs/en/reference/models/yolo/pose/train.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Explore Ultralytics PoseTrainer for YOLO models. Get a step-by-step guide on how to train on custom pose data for more accurate AI modeling.
keywords: Ultralytics, YOLO, PoseTrainer, pose training, AI modeling, custom data training
---
# Reference for `ultralytics/models/yolo/pose/train.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/pose/train.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/pose/train.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/pose/train.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.yolo.pose.train.PoseTrainer
<br><br>

16
docs/en/reference/models/yolo/pose/val.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Explore the PoseValidator—review how Ultralytics YOLO validates poses for object detection. Improve your understanding of YOLO.
keywords: PoseValidator, Ultralytics, YOLO, Object detection, Pose validation
---
# Reference for `ultralytics/models/yolo/pose/val.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/pose/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/pose/val.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/pose/val.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.yolo.pose.val.PoseValidator
<br><br>

16
docs/en/reference/models/yolo/segment/predict.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Discover how to utilize the YOLO Segmentation Predictor in Ultralytics. Enhance your objects detection skills with us.
keywords: YOLO, Ultralytics, object detection, segmentation predictor
---
# Reference for `ultralytics/models/yolo/segment/predict.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/segment/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/segment/predict.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/segment/predict.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.yolo.segment.predict.SegmentationPredictor
<br><br>

16
docs/en/reference/models/yolo/segment/train.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Maximize your YOLO model's performance with our SegmentationTrainer. Explore comprehensive guides and tutorials on ultralytics.com.
keywords: Ultralytics, YOLO, SegmentationTrainer, image segmentation, object detection, model training, YOLO model
---
# Reference for `ultralytics/models/yolo/segment/train.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/segment/train.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/segment/train.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/segment/train.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.yolo.segment.train.SegmentationTrainer
<br><br>

16
docs/en/reference/models/yolo/segment/val.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Get practical insights about our SegmentationValidator in YOLO Ultralytics models. Discover functionality details, methods, inputs, and outputs.
keywords: Ultralytics, YOLO, SegmentationValidator, model segmentation, image classification, object detection
---
# Reference for `ultralytics/models/yolo/segment/val.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/segment/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/segment/val.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/yolo/segment/val.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.models.yolo.segment.val.SegmentationValidator
<br><br>

24
docs/en/reference/nn/autobackend.md Normal file
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`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/autobackend.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/autobackend.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/nn/autobackend.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.nn.autobackend.AutoBackend
<br><br>
## ::: ultralytics.nn.autobackend.check_class_names
<br><br>
## ::: ultralytics.nn.autobackend.default_class_names
<br><br>

140
docs/en/reference/nn/modules/block.md Normal file
View File

@ -0,0 +1,140 @@
---
description: Explore Ultralytics YOLO neural network modules, Proto to BottleneckCSP. Detailed explanation of each module with easy-to-follow code examples.
keywords: YOLO, Ultralytics, neural network, nn.modules.block, Proto, HGBlock, SPPF, C2, C3, RepC3, C3Ghost, Bottleneck, BottleneckCSP
---
# Reference for `ultralytics/nn/modules/block.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/block.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/block.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/nn/modules/block.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.nn.modules.block.DFL
<br><br>
## ::: ultralytics.nn.modules.block.Proto
<br><br>
## ::: ultralytics.nn.modules.block.HGStem
<br><br>
## ::: ultralytics.nn.modules.block.HGBlock
<br><br>
## ::: ultralytics.nn.modules.block.SPP
<br><br>
## ::: ultralytics.nn.modules.block.SPPF
<br><br>
## ::: ultralytics.nn.modules.block.C1
<br><br>
## ::: ultralytics.nn.modules.block.C2
<br><br>
## ::: ultralytics.nn.modules.block.C2f
<br><br>
## ::: ultralytics.nn.modules.block.C3
<br><br>
## ::: ultralytics.nn.modules.block.C3x
<br><br>
## ::: ultralytics.nn.modules.block.RepC3
<br><br>
## ::: ultralytics.nn.modules.block.C3TR
<br><br>
## ::: ultralytics.nn.modules.block.C3Ghost
<br><br>
## ::: ultralytics.nn.modules.block.GhostBottleneck
<br><br>
## ::: ultralytics.nn.modules.block.Bottleneck
<br><br>
## ::: ultralytics.nn.modules.block.BottleneckCSP
<br><br>
## ::: ultralytics.nn.modules.block.ResNetBlock
<br><br>
## ::: ultralytics.nn.modules.block.ResNetLayer
<br><br>
## ::: ultralytics.nn.modules.block.MaxSigmoidAttnBlock
<br><br>
## ::: ultralytics.nn.modules.block.C2fAttn
<br><br>
## ::: ultralytics.nn.modules.block.ImagePoolingAttn
<br><br>
## ::: ultralytics.nn.modules.block.ContrastiveHead
<br><br>
## ::: ultralytics.nn.modules.block.BNContrastiveHead
<br><br>
## ::: ultralytics.nn.modules.block.RepBottleneck
<br><br>
## ::: ultralytics.nn.modules.block.RepCSP
<br><br>
## ::: ultralytics.nn.modules.block.RepNCSPELAN4
<br><br>
## ::: ultralytics.nn.modules.block.ADown
<br><br>
## ::: ultralytics.nn.modules.block.SPPELAN
<br><br>
## ::: ultralytics.nn.modules.block.Silence
<br><br>
## ::: ultralytics.nn.modules.block.CBLinear
<br><br>
## ::: ultralytics.nn.modules.block.CBFuse
<br><br>

68
docs/en/reference/nn/modules/conv.md Normal file
View File

@ -0,0 +1,68 @@
---
description: Explore various Ultralytics convolution modules including Conv2, DWConv, ConvTranspose, GhostConv, Channel Attention and more.
keywords: Ultralytics, Convolution Modules, Conv2, DWConv, ConvTranspose, GhostConv, ChannelAttention, CBAM, autopad
---
# Reference for `ultralytics/nn/modules/conv.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/conv.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/conv.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/nn/modules/conv.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.nn.modules.conv.Conv
<br><br>
## ::: ultralytics.nn.modules.conv.Conv2
<br><br>
## ::: ultralytics.nn.modules.conv.LightConv
<br><br>
## ::: ultralytics.nn.modules.conv.DWConv
<br><br>
## ::: ultralytics.nn.modules.conv.DWConvTranspose2d
<br><br>
## ::: ultralytics.nn.modules.conv.ConvTranspose
<br><br>
## ::: ultralytics.nn.modules.conv.Focus
<br><br>
## ::: ultralytics.nn.modules.conv.GhostConv
<br><br>
## ::: ultralytics.nn.modules.conv.RepConv
<br><br>
## ::: ultralytics.nn.modules.conv.ChannelAttention
<br><br>
## ::: ultralytics.nn.modules.conv.SpatialAttention
<br><br>
## ::: ultralytics.nn.modules.conv.CBAM
<br><br>
## ::: ultralytics.nn.modules.conv.Concat
<br><br>
## ::: ultralytics.nn.modules.conv.autopad
<br><br>

40
docs/en/reference/nn/modules/head.md Normal file
View File

@ -0,0 +1,40 @@
---
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`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/head.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/head.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/nn/modules/head.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.nn.modules.head.Detect
<br><br>
## ::: ultralytics.nn.modules.head.Segment
<br><br>
## ::: ultralytics.nn.modules.head.OBB
<br><br>
## ::: ultralytics.nn.modules.head.Pose
<br><br>
## ::: ultralytics.nn.modules.head.Classify
<br><br>
## ::: ultralytics.nn.modules.head.WorldDetect
<br><br>
## ::: ultralytics.nn.modules.head.RTDETRDecoder
<br><br>

52
docs/en/reference/nn/modules/transformer.md Normal file
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`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/transformer.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/transformer.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/nn/modules/transformer.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.nn.modules.transformer.TransformerEncoderLayer
<br><br>
## ::: ultralytics.nn.modules.transformer.AIFI
<br><br>
## ::: ultralytics.nn.modules.transformer.TransformerLayer
<br><br>
## ::: ultralytics.nn.modules.transformer.TransformerBlock
<br><br>
## ::: ultralytics.nn.modules.transformer.MLPBlock
<br><br>
## ::: ultralytics.nn.modules.transformer.MLP
<br><br>
## ::: ultralytics.nn.modules.transformer.LayerNorm2d
<br><br>
## ::: ultralytics.nn.modules.transformer.MSDeformAttn
<br><br>
## ::: ultralytics.nn.modules.transformer.DeformableTransformerDecoderLayer
<br><br>
## ::: ultralytics.nn.modules.transformer.DeformableTransformerDecoder
<br><br>

32
docs/en/reference/nn/modules/utils.md Normal file
View File

@ -0,0 +1,32 @@
---
description: Explore Ultralytics neural network utils, such as bias_init_with_prob, inverse_sigmoid and multi_scale_deformable_attn_pytorch functions.
keywords: Ultralytics, neural network, nn.modules.utils, bias_init_with_prob, inverse_sigmoid, multi_scale_deformable_attn_pytorch
---
# Reference for `ultralytics/nn/modules/utils.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/utils.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/nn/modules/utils.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.nn.modules.utils._get_clones
<br><br>
## ::: ultralytics.nn.modules.utils.bias_init_with_prob
<br><br>
## ::: ultralytics.nn.modules.utils.linear_init
<br><br>
## ::: ultralytics.nn.modules.utils.inverse_sigmoid
<br><br>
## ::: ultralytics.nn.modules.utils.multi_scale_deformable_attn_pytorch
<br><br>

80
docs/en/reference/nn/tasks.md Normal file
View File

@ -0,0 +1,80 @@
---
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`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/tasks.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/tasks.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/nn/tasks.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.nn.tasks.BaseModel
<br><br>
## ::: ultralytics.nn.tasks.DetectionModel
<br><br>
## ::: ultralytics.nn.tasks.OBBModel
<br><br>
## ::: ultralytics.nn.tasks.SegmentationModel
<br><br>
## ::: ultralytics.nn.tasks.PoseModel
<br><br>
## ::: ultralytics.nn.tasks.ClassificationModel
<br><br>
## ::: ultralytics.nn.tasks.RTDETRDetectionModel
<br><br>
## ::: ultralytics.nn.tasks.WorldModel
<br><br>
## ::: ultralytics.nn.tasks.Ensemble
<br><br>
## ::: ultralytics.nn.tasks.temporary_modules
<br><br>
## ::: ultralytics.nn.tasks.torch_safe_load
<br><br>
## ::: ultralytics.nn.tasks.attempt_load_weights
<br><br>
## ::: ultralytics.nn.tasks.attempt_load_one_weight
<br><br>
## ::: ultralytics.nn.tasks.parse_model
<br><br>
## ::: ultralytics.nn.tasks.yaml_model_load
<br><br>
## ::: ultralytics.nn.tasks.guess_model_scale
<br><br>
## ::: ultralytics.nn.tasks.guess_model_task
<br><br>

16
docs/en/reference/solutions/ai_gym.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Explore Ultralytics YOLO's advanced AI Gym feature for real-time pose estimation and gym exercise tracking using cutting-edge machine learning technology.
keywords: Ultralytics, YOLO, AI Gym, pose estimation, real-time tracking, machine learning, exercise counting, AI fitness, computer vision, gym workout analysis, YOLOv8, artificial intelligence, fitness technology
---
# Reference for `ultralytics/solutions/ai_gym.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/ai_gym.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/ai_gym.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/solutions/ai_gym.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.solutions.ai_gym.AIGym
<br><br>

16
docs/en/reference/solutions/distance_calculation.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Explore Ultralytics YOLO's distance calculation feature designed for advance analytics, providing an immediate, impactful way to interpret computer vision data.
keywords: Ultralytics, YOLO, distance calculation, object tracking, data visualization, real-time tracking, machine learning, object counting, computer vision, vehicle analytics, YOLOv8, artificial intelligence
---
# Reference for `ultralytics/solutions/distance_calculation.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/distance_calculation.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/distance_calculation.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/solutions/distance_calculation.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.solutions.distance_calculation.DistanceCalculation
<br><br>

16
docs/en/reference/solutions/heatmap.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Explore Ultralytics YOLO's advanced Heatmaps feature designed to highlight areas of interest, providing an immediate, impactful way to interpret spatial information.
keywords: Ultralytics, YOLO, heatmaps, object tracking, data visualization, real-time tracking, machine learning, object counting, computer vision, retail analytics, YOLOv8, artificial intelligence
---
# Reference for `ultralytics/solutions/heatmap.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/heatmap.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/heatmap.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/solutions/heatmap.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.solutions.heatmap.Heatmap
<br><br>

16
docs/en/reference/solutions/object_counter.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Transform object tracking with Ultralytics YOLO Object Counter featuring cutting-edge technology for precise real-time counting in video streams.
keywords: Ultralytics YOLO, object tracking software, real-time counting solutions, video stream analysis, YOLOv8 object detection, AI surveillance, smart counting technology, computer vision, AI-powered tracking, object counting accuracy, video analytics tools, automated monitoring.
---
# Reference for `ultralytics/solutions/object_counter.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/object_counter.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/object_counter.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/solutions/object_counter.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.solutions.object_counter.ObjectCounter
<br><br>

16
docs/en/reference/solutions/speed_estimation.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Transform speed estimation with Ultralytics YOLO speed estimation featuring cutting-edge technology for precise real-time counting in video streams.
keywords: Ultralytics YOLO, speed estimation software, real-time vehicle tracking solutions, video stream analysis, YOLOv8 object detection, smart counting technology, computer vision, AI-powered tracking, video analytics tools, automated monitoring.
---
# Reference for `ultralytics/solutions/speed_estimation.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/speed_estimation.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/speed_estimation.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/solutions/speed_estimation.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.solutions.speed_estimation.SpeedEstimator
<br><br>

20
docs/en/reference/trackers/basetrack.md Normal file
View File

@ -0,0 +1,20 @@
---
description: Get familiar with TrackState in Ultralytics. Learn how it is used in the BaseTrack of the Ultralytics tracker for enhanced functionality.
keywords: Ultralytics, TrackState, BaseTrack, Ultralytics tracker, Ultralytics documentation
---
# Reference for `ultralytics/trackers/basetrack.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/basetrack.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/basetrack.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/trackers/basetrack.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.trackers.basetrack.TrackState
<br><br>
## ::: ultralytics.trackers.basetrack.BaseTrack
<br><br>

20
docs/en/reference/trackers/bot_sort.md Normal file
View File

@ -0,0 +1,20 @@
---
description: Master the use of Ultralytics BOTrack, a key component of the powerful Ultralytics tracking system. Learn to integrate and use BOTSORT in your projects.
keywords: Ultralytics, BOTSORT, BOTrack, tracking system, official documentation, machine learning, AI tracking
---
# Reference for `ultralytics/trackers/bot_sort.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/bot_sort.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/bot_sort.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/trackers/bot_sort.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.trackers.bot_sort.BOTrack
<br><br>
## ::: ultralytics.trackers.bot_sort.BOTSORT
<br><br>

20
docs/en/reference/trackers/byte_tracker.md Normal file
View File

@ -0,0 +1,20 @@
---
description: Step-in to explore in-depth the functionalities of Ultralytics BYTETracker under STrack. Gain advanced feature insights to streamline your operations.
keywords: STrack, Ultralytics, BYTETracker, documentation, Ultralytics tracker, object tracking, YOLO
---
# Reference for `ultralytics/trackers/byte_tracker.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/byte_tracker.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/byte_tracker.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/trackers/byte_tracker.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.trackers.byte_tracker.STrack
<br><br>
## ::: ultralytics.trackers.byte_tracker.BYTETracker
<br><br>

24
docs/en/reference/trackers/track.md Normal file
View File

@ -0,0 +1,24 @@
---
description: Explore Ultralytics documentation on prediction function starters & register trackers. Understand our code & its applications better.
keywords: Ultralytics, YOLO, on predict start, register tracker, prediction functions, documentation
---
# Reference for `ultralytics/trackers/track.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/track.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/track.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/trackers/track.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.trackers.track.on_predict_start
<br><br>
## ::: ultralytics.trackers.track.on_predict_postprocess_end
<br><br>
## ::: ultralytics.trackers.track.register_tracker
<br><br>

16
docs/en/reference/trackers/utils/gmc.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Explore the Ultralytics GMC tool in our comprehensive documentation. Learn how it works, best practices, and implementation advice.
keywords: Ultralytics, GMC utility, Ultralytics documentation, Ultralytics tracker, machine learning tools
---
# Reference for `ultralytics/trackers/utils/gmc.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/utils/gmc.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/utils/gmc.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/trackers/utils/gmc.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.trackers.utils.gmc.GMC
<br><br>

20
docs/en/reference/trackers/utils/kalman_filter.md Normal file
View File

@ -0,0 +1,20 @@
---
description: Explore KalmanFilterXYAH, a key component of Ultralytics trackers. Understand its utilities and learn to leverage it in your own projects.
keywords: Ultralytics, KalmanFilterXYAH, tracker, documentation, guide
---
# Reference for `ultralytics/trackers/utils/kalman_filter.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/utils/kalman_filter.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/utils/kalman_filter.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/trackers/utils/kalman_filter.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.trackers.utils.kalman_filter.KalmanFilterXYAH
<br><br>
## ::: ultralytics.trackers.utils.kalman_filter.KalmanFilterXYWH
<br><br>

28
docs/en/reference/trackers/utils/matching.md Normal file
View File

@ -0,0 +1,28 @@
---
description: Explore in-depth guidance for using Ultralytics trackers utils matching, including merge_matches, linear_assignment, iou_distance, embedding_distance, fuse_motion, and fuse_score.
keywords: Ultralytics, Trackers Utils, Matching, merge_matches, linear_assignment, iou_distance, embedding_distance, fuse_motion, fuse_score, documentation
---
# Reference for `ultralytics/trackers/utils/matching.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/utils/matching.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/utils/matching.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/trackers/utils/matching.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.trackers.utils.matching.linear_assignment
<br><br>
## ::: ultralytics.trackers.utils.matching.iou_distance
<br><br>
## ::: ultralytics.trackers.utils.matching.embedding_distance
<br><br>
## ::: ultralytics.trackers.utils.matching.fuse_score
<br><br>

160
docs/en/reference/utils/__init__.md Normal file
View File

@ -0,0 +1,160 @@
---
description: Explore the Ultralytics Utils package, with handy functions like colorstr, yaml_save, set_logging & more, designed to enhance your coding experience.
keywords: Ultralytics, Utils, utilitarian functions, colorstr, yaml_save, set_logging, is_kaggle, is_docker, clean_url
---
# Reference for `ultralytics/utils/__init__.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/__init__.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/__init__.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/__init__.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.TQDM
<br><br>
## ::: ultralytics.utils.SimpleClass
<br><br>
## ::: ultralytics.utils.IterableSimpleNamespace
<br><br>
## ::: ultralytics.utils.ThreadingLocked
<br><br>
## ::: ultralytics.utils.TryExcept
<br><br>
## ::: ultralytics.utils.Retry
<br><br>
## ::: ultralytics.utils.SettingsManager
<br><br>
## ::: ultralytics.utils.plt_settings
<br><br>
## ::: ultralytics.utils.set_logging
<br><br>
## ::: ultralytics.utils.emojis
<br><br>
## ::: ultralytics.utils.yaml_save
<br><br>
## ::: ultralytics.utils.yaml_load
<br><br>
## ::: ultralytics.utils.yaml_print
<br><br>
## ::: ultralytics.utils.is_ubuntu
<br><br>
## ::: ultralytics.utils.is_colab
<br><br>
## ::: ultralytics.utils.is_kaggle
<br><br>
## ::: ultralytics.utils.is_jupyter
<br><br>
## ::: ultralytics.utils.is_docker
<br><br>
## ::: ultralytics.utils.is_online
<br><br>
## ::: ultralytics.utils.is_pip_package
<br><br>
## ::: ultralytics.utils.is_dir_writeable
<br><br>
## ::: ultralytics.utils.is_pytest_running
<br><br>
## ::: ultralytics.utils.is_github_action_running
<br><br>
## ::: ultralytics.utils.is_git_dir
<br><br>
## ::: ultralytics.utils.get_git_dir
<br><br>
## ::: ultralytics.utils.get_git_origin_url
<br><br>
## ::: ultralytics.utils.get_git_branch
<br><br>
## ::: ultralytics.utils.get_default_args
<br><br>
## ::: ultralytics.utils.get_ubuntu_version
<br><br>
## ::: ultralytics.utils.get_user_config_dir
<br><br>
## ::: ultralytics.utils.colorstr
<br><br>
## ::: ultralytics.utils.remove_colorstr
<br><br>
## ::: ultralytics.utils.threaded
<br><br>
## ::: ultralytics.utils.set_sentry
<br><br>
## ::: ultralytics.utils.deprecation_warn
<br><br>
## ::: ultralytics.utils.clean_url
<br><br>
## ::: ultralytics.utils.url2file
<br><br>

20
docs/en/reference/utils/autobatch.md Normal file
View File

@ -0,0 +1,20 @@
---
description: Explore Ultralytics documentation for check_train_batch_size utility in the autobatch module. Understand how it could improve your machine learning process.
keywords: Ultralytics, check_train_batch_size, autobatch, utility, machine learning, documentation
---
# Reference for `ultralytics/utils/autobatch.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/autobatch.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/autobatch.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/autobatch.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.autobatch.check_train_batch_size
<br><br>
## ::: ultralytics.utils.autobatch.autobatch
<br><br>

20
docs/en/reference/utils/benchmarks.md Normal file
View File

@ -0,0 +1,20 @@
---
description: Discover how to profile your models using Ultralytics utilities. Enhance performance, optimize your benchmarks, and learn best practices.
keywords: Ultralytics, ProfileModels, benchmarks, model profiling, performance optimization
---
# Reference for `ultralytics/utils/benchmarks.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/benchmarks.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/benchmarks.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/benchmarks.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.benchmarks.ProfileModels
<br><br>
## ::: ultralytics.utils.benchmarks.benchmark
<br><br>

120
docs/en/reference/utils/callbacks/base.md Normal file
View File

@ -0,0 +1,120 @@
---
description: Explore how to use the on-train, on-validation, on-pretrain, and on-predict callbacks in Ultralytics. Learn to update params, save models, and add integration callbacks.
keywords: Ultralytics, Callbacks, On-train, On-validation, On-pretrain, On-predict, Parameters update, Model saving, Integration callbacks
---
# Reference for `ultralytics/utils/callbacks/base.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/base.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/base.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/base.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.callbacks.base.on_pretrain_routine_start
<br><br>
## ::: ultralytics.utils.callbacks.base.on_pretrain_routine_end
<br><br>
## ::: ultralytics.utils.callbacks.base.on_train_start
<br><br>
## ::: ultralytics.utils.callbacks.base.on_train_epoch_start
<br><br>
## ::: ultralytics.utils.callbacks.base.on_train_batch_start
<br><br>
## ::: ultralytics.utils.callbacks.base.optimizer_step
<br><br>
## ::: ultralytics.utils.callbacks.base.on_before_zero_grad
<br><br>
## ::: ultralytics.utils.callbacks.base.on_train_batch_end
<br><br>
## ::: ultralytics.utils.callbacks.base.on_train_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.base.on_fit_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.base.on_model_save
<br><br>
## ::: ultralytics.utils.callbacks.base.on_train_end
<br><br>
## ::: ultralytics.utils.callbacks.base.on_params_update
<br><br>
## ::: ultralytics.utils.callbacks.base.teardown
<br><br>
## ::: ultralytics.utils.callbacks.base.on_val_start
<br><br>
## ::: ultralytics.utils.callbacks.base.on_val_batch_start
<br><br>
## ::: ultralytics.utils.callbacks.base.on_val_batch_end
<br><br>
## ::: ultralytics.utils.callbacks.base.on_val_end
<br><br>
## ::: ultralytics.utils.callbacks.base.on_predict_start
<br><br>
## ::: ultralytics.utils.callbacks.base.on_predict_batch_start
<br><br>
## ::: ultralytics.utils.callbacks.base.on_predict_batch_end
<br><br>
## ::: ultralytics.utils.callbacks.base.on_predict_postprocess_end
<br><br>
## ::: ultralytics.utils.callbacks.base.on_predict_end
<br><br>
## ::: ultralytics.utils.callbacks.base.on_export_start
<br><br>
## ::: ultralytics.utils.callbacks.base.on_export_end
<br><br>
## ::: ultralytics.utils.callbacks.base.get_default_callbacks
<br><br>
## ::: ultralytics.utils.callbacks.base.add_integration_callbacks
<br><br>

40
docs/en/reference/utils/callbacks/clearml.md Normal file
View File

@ -0,0 +1,40 @@
---
description: Uncover the specifics of Ultralytics ClearML callbacks, from pretrain routine start to training end. Boost your ML model performance.
keywords: Ultralytics, clearML, callbacks, pretrain routine start, validation end, train epoch end, training end
---
# Reference for `ultralytics/utils/callbacks/clearml.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/clearml.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/clearml.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/clearml.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.callbacks.clearml._log_debug_samples
<br><br>
## ::: ultralytics.utils.callbacks.clearml._log_plot
<br><br>
## ::: ultralytics.utils.callbacks.clearml.on_pretrain_routine_start
<br><br>
## ::: ultralytics.utils.callbacks.clearml.on_train_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.clearml.on_fit_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.clearml.on_val_end
<br><br>
## ::: ultralytics.utils.callbacks.clearml.on_train_end
<br><br>

108
docs/en/reference/utils/callbacks/comet.md Normal file
View File

@ -0,0 +1,108 @@
---
description: Explore comprehensive documentation for utilising Comet Callbacks in Ultralytics. Learn to optimise training, logging, and experiment workflows.
keywords: Ultralytics, Comet Callbacks, Training optimisation, Logging, Experiment Workflows
---
# Reference for `ultralytics/utils/callbacks/comet.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/comet.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/comet.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/comet.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.callbacks.comet._get_comet_mode
<br><br>
## ::: ultralytics.utils.callbacks.comet._get_comet_model_name
<br><br>
## ::: ultralytics.utils.callbacks.comet._get_eval_batch_logging_interval
<br><br>
## ::: ultralytics.utils.callbacks.comet._get_max_image_predictions_to_log
<br><br>
## ::: ultralytics.utils.callbacks.comet._scale_confidence_score
<br><br>
## ::: ultralytics.utils.callbacks.comet._should_log_confusion_matrix
<br><br>
## ::: ultralytics.utils.callbacks.comet._should_log_image_predictions
<br><br>
## ::: ultralytics.utils.callbacks.comet._get_experiment_type
<br><br>
## ::: ultralytics.utils.callbacks.comet._create_experiment
<br><br>
## ::: ultralytics.utils.callbacks.comet._fetch_trainer_metadata
<br><br>
## ::: ultralytics.utils.callbacks.comet._scale_bounding_box_to_original_image_shape
<br><br>
## ::: ultralytics.utils.callbacks.comet._format_ground_truth_annotations_for_detection
<br><br>
## ::: ultralytics.utils.callbacks.comet._format_prediction_annotations_for_detection
<br><br>
## ::: ultralytics.utils.callbacks.comet._fetch_annotations
<br><br>
## ::: ultralytics.utils.callbacks.comet._create_prediction_metadata_map
<br><br>
## ::: ultralytics.utils.callbacks.comet._log_confusion_matrix
<br><br>
## ::: ultralytics.utils.callbacks.comet._log_images
<br><br>
## ::: ultralytics.utils.callbacks.comet._log_image_predictions
<br><br>
## ::: ultralytics.utils.callbacks.comet._log_plots
<br><br>
## ::: ultralytics.utils.callbacks.comet._log_model
<br><br>
## ::: ultralytics.utils.callbacks.comet.on_pretrain_routine_start
<br><br>
## ::: ultralytics.utils.callbacks.comet.on_train_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.comet.on_fit_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.comet.on_train_end
<br><br>

48
docs/en/reference/utils/callbacks/dvc.md Normal file
View File

@ -0,0 +1,48 @@
---
description: Browse through Ultralytics YOLO docs to learn about important logging and callback functions used in training and pretraining models.
keywords: Ultralytics, YOLO, callbacks, logger, training, pretraining, machine learning, models
---
# Reference for `ultralytics/utils/callbacks/dvc.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/dvc.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/dvc.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/dvc.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.callbacks.dvc._log_images
<br><br>
## ::: ultralytics.utils.callbacks.dvc._log_plots
<br><br>
## ::: ultralytics.utils.callbacks.dvc._log_confusion_matrix
<br><br>
## ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_start
<br><br>
## ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_end
<br><br>
## ::: ultralytics.utils.callbacks.dvc.on_train_start
<br><br>
## ::: ultralytics.utils.callbacks.dvc.on_train_epoch_start
<br><br>
## ::: ultralytics.utils.callbacks.dvc.on_fit_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.dvc.on_train_end
<br><br>

44
docs/en/reference/utils/callbacks/hub.md Normal file
View File

@ -0,0 +1,44 @@
---
description: Explore the detailed information on key Ultralytics callbacks such as on_pretrain_routine_end, on_model_save, on_train_start, and on_predict_start.
keywords: Ultralytics, callbacks, on_pretrain_routine_end, on_model_save, on_train_start, on_predict_start, hub, training
---
# Reference for `ultralytics/utils/callbacks/hub.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/hub.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/hub.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/hub.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.callbacks.hub.on_pretrain_routine_end
<br><br>
## ::: ultralytics.utils.callbacks.hub.on_fit_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.hub.on_model_save
<br><br>
## ::: ultralytics.utils.callbacks.hub.on_train_end
<br><br>
## ::: ultralytics.utils.callbacks.hub.on_train_start
<br><br>
## ::: ultralytics.utils.callbacks.hub.on_val_start
<br><br>
## ::: ultralytics.utils.callbacks.hub.on_predict_start
<br><br>
## ::: ultralytics.utils.callbacks.hub.on_export_start
<br><br>

28
docs/en/reference/utils/callbacks/mlflow.md Normal file
View File

@ -0,0 +1,28 @@
---
description: Understand routines at the end of pre-training and training in Ultralytics. Elevate your MLflow callbacks expertise.
keywords: Ultralytics, MLflow, Callbacks, on_pretrain_routine_end, on_train_end, Machine Learning, Training
---
# Reference for `ultralytics/utils/callbacks/mlflow.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/mlflow.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/mlflow.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/mlflow.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.callbacks.mlflow.on_pretrain_routine_end
<br><br>
## ::: ultralytics.utils.callbacks.mlflow.on_train_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.mlflow.on_fit_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.mlflow.on_train_end
<br><br>

44
docs/en/reference/utils/callbacks/neptune.md Normal file
View File

@ -0,0 +1,44 @@
---
description: Explore exhaustive details about Ultralytics callbacks in Neptune, with specifics about scalar logging, routine start, and more.
keywords: Ultralytics, Neptune callbacks, on_train_epoch_end, on_val_end, _log_plot, _log_images, on_pretrain_routine_start, on_fit_epoch_end, on_train_end
---
# Reference for `ultralytics/utils/callbacks/neptune.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/neptune.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/neptune.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/neptune.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.callbacks.neptune._log_scalars
<br><br>
## ::: ultralytics.utils.callbacks.neptune._log_images
<br><br>
## ::: ultralytics.utils.callbacks.neptune._log_plot
<br><br>
## ::: ultralytics.utils.callbacks.neptune.on_pretrain_routine_start
<br><br>
## ::: ultralytics.utils.callbacks.neptune.on_train_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.neptune.on_fit_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.neptune.on_val_end
<br><br>
## ::: ultralytics.utils.callbacks.neptune.on_train_end
<br><br>

16
docs/en/reference/utils/callbacks/raytune.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Discover the functionality of the on_fit_epoch_end callback in the Ultralytics YOLO framework. Learn how to end an epoch in your deep learning projects.
keywords: Ultralytics, YOLO, on_fit_epoch_end, callbacks, documentation, deep learning, YOLO framework
---
# Reference for `ultralytics/utils/callbacks/raytune.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/raytune.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/raytune.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/raytune.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.callbacks.raytune.on_fit_epoch_end
<br><br>

36
docs/en/reference/utils/callbacks/tensorboard.md Normal file
View File

@ -0,0 +1,36 @@
---
description: Explore Ultralytics YOLO Docs for a deep understanding of log_scalars, on_batch_end & other callback utilities embedded in the tensorboard module.
keywords: Ultralytics, YOLO, documentation, callback utilities, log_scalars, on_batch_end, tensorboard
---
# Reference for `ultralytics/utils/callbacks/tensorboard.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/tensorboard.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/tensorboard.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/tensorboard.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.callbacks.tensorboard._log_scalars
<br><br>
## ::: ultralytics.utils.callbacks.tensorboard._log_tensorboard_graph
<br><br>
## ::: ultralytics.utils.callbacks.tensorboard.on_pretrain_routine_start
<br><br>
## ::: ultralytics.utils.callbacks.tensorboard.on_train_start
<br><br>
## ::: ultralytics.utils.callbacks.tensorboard.on_train_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.tensorboard.on_fit_epoch_end
<br><br>

40
docs/en/reference/utils/callbacks/wb.md Normal file
View File

@ -0,0 +1,40 @@
---
description: Deep dive into Ultralytics callbacks. Learn how to use the _log_plots, on_fit_epoch_end, and on_train_end functions effectively.
keywords: Ultralytics, callbacks, _log_plots, on_fit_epoch_end, on_train_end
---
# Reference for `ultralytics/utils/callbacks/wb.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/wb.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/wb.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/wb.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.callbacks.wb._custom_table
<br><br>
## ::: ultralytics.utils.callbacks.wb._plot_curve
<br><br>
## ::: ultralytics.utils.callbacks.wb._log_plots
<br><br>
## ::: ultralytics.utils.callbacks.wb.on_pretrain_routine_start
<br><br>
## ::: ultralytics.utils.callbacks.wb.on_fit_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.wb.on_train_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.wb.on_train_end
<br><br>

112
docs/en/reference/utils/checks.md Normal file
View File

@ -0,0 +1,112 @@
---
description: Learn about our routine checks that safeguard Ultralytics operations including ASCII, font, YOLO file, YAML, Python and torchvision checks.
keywords: Ultralytics, utility checks, ASCII, check_version, pip_update, check_python, check_torchvision, check_yaml, YOLO filename
---
# Reference for `ultralytics/utils/checks.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/checks.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/checks.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/checks.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.checks.parse_requirements
<br><br>
## ::: ultralytics.utils.checks.parse_version
<br><br>
## ::: ultralytics.utils.checks.is_ascii
<br><br>
## ::: ultralytics.utils.checks.check_imgsz
<br><br>
## ::: ultralytics.utils.checks.check_version
<br><br>
## ::: ultralytics.utils.checks.check_latest_pypi_version
<br><br>
## ::: ultralytics.utils.checks.check_pip_update_available
<br><br>
## ::: ultralytics.utils.checks.check_font
<br><br>
## ::: ultralytics.utils.checks.check_python
<br><br>
## ::: ultralytics.utils.checks.check_requirements
<br><br>
## ::: ultralytics.utils.checks.check_torchvision
<br><br>
## ::: ultralytics.utils.checks.check_suffix
<br><br>
## ::: ultralytics.utils.checks.check_yolov5u_filename
<br><br>
## ::: ultralytics.utils.checks.check_model_file_from_stem
<br><br>
## ::: ultralytics.utils.checks.check_file
<br><br>
## ::: ultralytics.utils.checks.check_yaml
<br><br>
## ::: ultralytics.utils.checks.check_is_path_safe
<br><br>
## ::: ultralytics.utils.checks.check_imshow
<br><br>
## ::: ultralytics.utils.checks.check_yolo
<br><br>
## ::: ultralytics.utils.checks.collect_system_info
<br><br>
## ::: ultralytics.utils.checks.check_amp
<br><br>
## ::: ultralytics.utils.checks.git_describe
<br><br>
## ::: ultralytics.utils.checks.print_args
<br><br>
## ::: ultralytics.utils.checks.cuda_device_count
<br><br>
## ::: ultralytics.utils.checks.cuda_is_available
<br><br>

28
docs/en/reference/utils/dist.md Normal file
View File

@ -0,0 +1,28 @@
---
description: Discover the role of dist.find_free_network_port & dist.generate_ddp_command in Ultralytics DDP utilities. Use our guide for efficient deployment.
keywords: Ultralytics, DDP, DDP utility functions, Distributed Data Processing, find free network port, generate DDP command
---
# Reference for `ultralytics/utils/dist.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/dist.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/dist.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/dist.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.dist.find_free_network_port
<br><br>
## ::: ultralytics.utils.dist.generate_ddp_file
<br><br>
## ::: ultralytics.utils.dist.generate_ddp_command
<br><br>
## ::: ultralytics.utils.dist.ddp_cleanup
<br><br>

52
docs/en/reference/utils/downloads.md Normal file
View File

@ -0,0 +1,52 @@
---
description: Learn about the download utilities in Ultralytics YOLO, featuring functions like is_url, check_disk_space, get_github_assets, and download.
keywords: Ultralytics, YOLO, download utilities, is_url, check_disk_space, get_github_assets, download, documentation
---
# Reference for `ultralytics/utils/downloads.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/downloads.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/downloads.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/downloads.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.downloads.is_url
<br><br>
## ::: ultralytics.utils.downloads.delete_dsstore
<br><br>
## ::: ultralytics.utils.downloads.zip_directory
<br><br>
## ::: ultralytics.utils.downloads.unzip_file
<br><br>
## ::: ultralytics.utils.downloads.check_disk_space
<br><br>
## ::: ultralytics.utils.downloads.get_google_drive_file_info
<br><br>
## ::: ultralytics.utils.downloads.safe_download
<br><br>
## ::: ultralytics.utils.downloads.get_github_assets
<br><br>
## ::: ultralytics.utils.downloads.attempt_download_asset
<br><br>
## ::: ultralytics.utils.downloads.download
<br><br>

16
docs/en/reference/utils/errors.md Normal file
View File

@ -0,0 +1,16 @@
---
description: Learn about the HUBModelError in Ultralytics. Enhance your understanding, troubleshoot errors and optimize your machine learning projects.
keywords: Ultralytics, HUBModelError, Machine Learning, Error troubleshooting, Ultralytics documentation
---
# Reference for `ultralytics/utils/errors.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/errors.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/errors.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/errors.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.errors.HUBModelError
<br><br>

44
docs/en/reference/utils/files.md Normal file
View File

@ -0,0 +1,44 @@
---
description: Discover how to use Ultralytics utility functions for file-related operations including incrementing paths, finding file age, checking file size and creating directories.
keywords: Ultralytics, utility functions, file operations, working directory, file age, file size, create directories
---
# Reference for `ultralytics/utils/files.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/files.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/files.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/files.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.files.WorkingDirectory
<br><br>
## ::: ultralytics.utils.files.spaces_in_path
<br><br>
## ::: ultralytics.utils.files.increment_path
<br><br>
## ::: ultralytics.utils.files.file_age
<br><br>
## ::: ultralytics.utils.files.file_date
<br><br>
## ::: ultralytics.utils.files.file_size
<br><br>
## ::: ultralytics.utils.files.get_latest_run
<br><br>
## ::: ultralytics.utils.files.update_models
<br><br>

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