diff --git a/docs/build_reference.py b/docs/build_reference.py index 7524c682..a11b7e25 100644 --- a/docs/build_reference.py +++ b/docs/build_reference.py @@ -44,12 +44,14 @@ def create_markdown(py_filepath, module_path, classes, functions): if 'description:' in part or 'comments:' in part: header_content += f'---{part}---\n\n' - module_path = module_path.replace('.__init__', '') - module_sep = module_path.replace(".", "/") - url = f'https://github.com/ultralytics/ultralytics/blob/main/{module_sep}.py' - title_content = f'# Reference for `{module_sep}.py`\n\n!!! note\n\n Full source code for this file is available at [{url}]({url}).\n\n' - md_content = [f'---\n## ::: {module_path}.{class_name}\n

\n' for class_name in classes] - md_content.extend(f'---\n## ::: {module_path}.{func_name}\n

\n' for func_name in functions) + module_name = module_path.replace('.__init__', '') + module_path = module_path.replace(".", "/") + url = f'https://github.com/ultralytics/ultralytics/blob/main/{module_path}.py' + title_content = (f'# Reference for `{module_path}.py`\n\n' + f'!!! note\n\n' + f' Full source code for this file is available at [{url}]({url}). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏!\n\n') + md_content = [f'---\n## ::: {module_name}.{class_name}\n

\n' for class_name in classes] + md_content.extend(f'---\n## ::: {module_name}.{func_name}\n

\n' for func_name in functions) md_content = header_content + title_content + '\n'.join(md_content) if not md_content.endswith('\n'): md_content += '\n' diff --git a/docs/reference/cfg/__init__.md b/docs/reference/cfg/__init__.md index 0dcfc575..0f4813a0 100644 --- a/docs/reference/cfg/__init__.md +++ b/docs/reference/cfg/__init__.md @@ -3,11 +3,11 @@ description: Explore Ultralytics cfg functions like cfg2dict, handle_deprecation keywords: Ultralytics, YOLO, Configuration, cfg2dict, handle_deprecation, merge_equals_args, handle_yolo_settings, copy_default_cfg, Image Detection --- -# Reference for `ultralytics/cfg.py` +# Reference for `ultralytics/cfg/__init__.py` !!! note - Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg.py). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.cfg.cfg2dict diff --git a/docs/reference/data/annotator.md b/docs/reference/data/annotator.md index e797c137..79213063 100644 --- a/docs/reference/data/annotator.md +++ b/docs/reference/data/annotator.md @@ -7,7 +7,7 @@ keywords: Ultralytics, Auto-Annotate, Machine Learning, AI, Annotation, Data Pro !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.data.annotator.auto_annotate diff --git a/docs/reference/data/augment.md b/docs/reference/data/augment.md index 5f958f37..72a6612e 100644 --- a/docs/reference/data/augment.md +++ b/docs/reference/data/augment.md @@ -7,7 +7,7 @@ keywords: Ultralytics, Data Augmentation, BaseTransform, MixUp, RandomHSV, Lette !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.data.augment.BaseTransform diff --git a/docs/reference/data/base.md b/docs/reference/data/base.md index f0272215..4ddae11a 100644 --- a/docs/reference/data/base.md +++ b/docs/reference/data/base.md @@ -7,7 +7,7 @@ keywords: Ultralytics, docs, BaseDataset, data manipulation, dataset creation !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.data.base.BaseDataset diff --git a/docs/reference/data/build.md b/docs/reference/data/build.md index fa279137..7972628d 100644 --- a/docs/reference/data/build.md +++ b/docs/reference/data/build.md @@ -7,7 +7,7 @@ keywords: Ultralytics, YOLO v3, Data build, DataLoader, InfiniteDataLoader, seed !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.data.build.InfiniteDataLoader diff --git a/docs/reference/data/converter.md b/docs/reference/data/converter.md index b0df74de..9167f23a 100644 --- a/docs/reference/data/converter.md +++ b/docs/reference/data/converter.md @@ -7,7 +7,7 @@ keywords: Ultralytics, Data Converter, coco91_to_coco80_class, merge_multi_segme !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.data.converter.coco91_to_coco80_class diff --git a/docs/reference/data/dataset.md b/docs/reference/data/dataset.md index ecd5ac52..8a41cf4b 100644 --- a/docs/reference/data/dataset.md +++ b/docs/reference/data/dataset.md @@ -7,7 +7,7 @@ keywords: Ultralytics, YOLO, YOLODataset, SemanticDataset, data handling, data m !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.data.dataset.YOLODataset diff --git a/docs/reference/data/loaders.md b/docs/reference/data/loaders.md index 41b5e51d..21d32f5c 100644 --- a/docs/reference/data/loaders.md +++ b/docs/reference/data/loaders.md @@ -7,7 +7,7 @@ keywords: Ultralytics, data loaders, LoadStreams, LoadImages, LoadTensor, YOLO, !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.data.loaders.SourceTypes diff --git a/docs/reference/data/utils.md b/docs/reference/data/utils.md index f9e7a219..370feb66 100644 --- a/docs/reference/data/utils.md +++ b/docs/reference/data/utils.md @@ -7,7 +7,7 @@ keywords: Ultralytics, data utils, YOLO, img2label_paths, exif_size, polygon2mas !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.data.utils.HUBDatasetStats diff --git a/docs/reference/engine/exporter.md b/docs/reference/engine/exporter.md index e3c9ae1f..d32342a9 100644 --- a/docs/reference/engine/exporter.md +++ b/docs/reference/engine/exporter.md @@ -7,7 +7,7 @@ keywords: Ultralytics, Exporter, iOSDetectModel, Export Formats, Try export !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.engine.exporter.Exporter diff --git a/docs/reference/engine/model.md b/docs/reference/engine/model.md index 1085fb63..b757639d 100644 --- a/docs/reference/engine/model.md +++ b/docs/reference/engine/model.md @@ -7,7 +7,7 @@ keywords: Ultralytics, YOLO, engine model, documentation, guide, implementation, !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.engine.model.Model diff --git a/docs/reference/engine/predictor.md b/docs/reference/engine/predictor.md index 6c3865a0..31d120f5 100644 --- a/docs/reference/engine/predictor.md +++ b/docs/reference/engine/predictor.md @@ -7,7 +7,7 @@ keywords: Ultralytics, BasePredictor, YOLO, prediction, engine !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.engine.predictor.BasePredictor diff --git a/docs/reference/engine/results.md b/docs/reference/engine/results.md index 4c673ffd..90482768 100644 --- a/docs/reference/engine/results.md +++ b/docs/reference/engine/results.md @@ -7,7 +7,7 @@ keywords: Ultralytics, engine, results, base tensor, boxes, keypoints !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.engine.results.BaseTensor diff --git a/docs/reference/engine/trainer.md b/docs/reference/engine/trainer.md index e3c5cd0d..1087a5f0 100644 --- a/docs/reference/engine/trainer.md +++ b/docs/reference/engine/trainer.md @@ -7,7 +7,7 @@ keywords: Ultralytics, BaseTrainer, Machine Learning, Training Control, Python l !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.engine.trainer.BaseTrainer diff --git a/docs/reference/engine/validator.md b/docs/reference/engine/validator.md index d48338fa..7952068e 100644 --- a/docs/reference/engine/validator.md +++ b/docs/reference/engine/validator.md @@ -7,7 +7,7 @@ keywords: Ultralytics, BaseValidator, Ultralytics engine, module, components !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.engine.validator.BaseValidator diff --git a/docs/reference/hub/__init__.md b/docs/reference/hub/__init__.md index 90348e37..4218ba52 100644 --- a/docs/reference/hub/__init__.md +++ b/docs/reference/hub/__init__.md @@ -3,11 +3,11 @@ description: Explore Ultralytics hub functions for model resetting, checking dat keywords: Ultralytics, hub functions, model export, dataset check, reset model, YOLO Docs --- -# Reference for `ultralytics/hub.py` +# Reference for `ultralytics/hub/__init__.py` !!! note - Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/hub.py). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.hub.login diff --git a/docs/reference/hub/auth.md b/docs/reference/hub/auth.md index 7f5f7f2a..a18a6bff 100644 --- a/docs/reference/hub/auth.md +++ b/docs/reference/hub/auth.md @@ -7,7 +7,7 @@ keywords: Ultralytics, Auth, API documentation, User Authentication, AI, Machine !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.hub.auth.Auth diff --git a/docs/reference/hub/session.md b/docs/reference/hub/session.md index a23d4cf8..618d07c1 100644 --- a/docs/reference/hub/session.md +++ b/docs/reference/hub/session.md @@ -7,7 +7,7 @@ keywords: Ultralytics, HUBTrainingSession, Documentation, Model Training, AI, Ma !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.hub.session.HUBTrainingSession diff --git a/docs/reference/hub/utils.md b/docs/reference/hub/utils.md index 9378e2ff..449bd450 100644 --- a/docs/reference/hub/utils.md +++ b/docs/reference/hub/utils.md @@ -7,7 +7,7 @@ keywords: Ultralytics, Events, request_with_credentials, smart_request, Ultralyt !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.hub.utils.Events diff --git a/docs/reference/models/fastsam/model.md b/docs/reference/models/fastsam/model.md index a7952e32..6bc6a958 100644 --- a/docs/reference/models/fastsam/model.md +++ b/docs/reference/models/fastsam/model.md @@ -7,7 +7,7 @@ keywords: Ultralytics, FastSAM model, Model documentation, Efficient model train !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.fastsam.model.FastSAM diff --git a/docs/reference/models/fastsam/predict.md b/docs/reference/models/fastsam/predict.md index 4a3431be..9ebbd607 100644 --- a/docs/reference/models/fastsam/predict.md +++ b/docs/reference/models/fastsam/predict.md @@ -7,7 +7,7 @@ keywords: Ultralytics, FastSAMPredictor, predictive modeling, AI optimization, m !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.fastsam.predict.FastSAMPredictor diff --git a/docs/reference/models/fastsam/prompt.md b/docs/reference/models/fastsam/prompt.md index ae5305c8..caecee56 100644 --- a/docs/reference/models/fastsam/prompt.md +++ b/docs/reference/models/fastsam/prompt.md @@ -7,7 +7,7 @@ keywords: Ultralytics, FastSAMPrompt, machine learning, model, guide, documentat !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.fastsam.prompt.FastSAMPrompt diff --git a/docs/reference/models/fastsam/utils.md b/docs/reference/models/fastsam/utils.md index 02f1e562..fb7c2bed 100644 --- a/docs/reference/models/fastsam/utils.md +++ b/docs/reference/models/fastsam/utils.md @@ -7,7 +7,7 @@ keywords: Ultralytics, bounding boxes, Bboxes, image borders, object detection, !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.fastsam.utils.adjust_bboxes_to_image_border diff --git a/docs/reference/models/fastsam/val.md b/docs/reference/models/fastsam/val.md index d6f6e6e0..fb797b34 100644 --- a/docs/reference/models/fastsam/val.md +++ b/docs/reference/models/fastsam/val.md @@ -7,7 +7,7 @@ keywords: Ultralytics, FastSAMValidator, model, synthetic, AI, machine learning, !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.fastsam.val.FastSAMValidator diff --git a/docs/reference/models/nas/model.md b/docs/reference/models/nas/model.md index c28c8251..c640a30c 100644 --- a/docs/reference/models/nas/model.md +++ b/docs/reference/models/nas/model.md @@ -7,7 +7,7 @@ keywords: Ultralytics, NAS model, NAS guide, machine learning, model documentati !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.nas.model.NAS diff --git a/docs/reference/models/nas/predict.md b/docs/reference/models/nas/predict.md index 58df075b..dfa693b6 100644 --- a/docs/reference/models/nas/predict.md +++ b/docs/reference/models/nas/predict.md @@ -7,7 +7,7 @@ keywords: NASPredictor, Ultralytics, Ultralytics model, model architecture, effi !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.nas.predict.NASPredictor diff --git a/docs/reference/models/nas/val.md b/docs/reference/models/nas/val.md index aca74d3d..5fe18042 100644 --- a/docs/reference/models/nas/val.md +++ b/docs/reference/models/nas/val.md @@ -7,7 +7,7 @@ keywords: Ultralytics, NASValidator, models.nas.val.NASValidator, AI models, all !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.nas.val.NASValidator diff --git a/docs/reference/models/rtdetr/model.md b/docs/reference/models/rtdetr/model.md index 90427108..5a561774 100644 --- a/docs/reference/models/rtdetr/model.md +++ b/docs/reference/models/rtdetr/model.md @@ -7,7 +7,7 @@ keywords: Ultralytics, RTDETR model, Ultralytics models, object detection, Ultra !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.rtdetr.model.RTDETR diff --git a/docs/reference/models/rtdetr/predict.md b/docs/reference/models/rtdetr/predict.md index d5be43b6..401f5108 100644 --- a/docs/reference/models/rtdetr/predict.md +++ b/docs/reference/models/rtdetr/predict.md @@ -7,7 +7,7 @@ keywords: Ultralytics, RTDETRPredictor, model documentation, guide, real-time ob !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.rtdetr.predict.RTDETRPredictor diff --git a/docs/reference/models/rtdetr/train.md b/docs/reference/models/rtdetr/train.md index a260cff0..40f67da1 100644 --- a/docs/reference/models/rtdetr/train.md +++ b/docs/reference/models/rtdetr/train.md @@ -7,7 +7,7 @@ keywords: Ultralytics, RTDETRTrainer, model training, Ultralytics models, PyTorc !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.rtdetr.train.RTDETRTrainer diff --git a/docs/reference/models/rtdetr/val.md b/docs/reference/models/rtdetr/val.md index 3ee076c3..0009c0d6 100644 --- a/docs/reference/models/rtdetr/val.md +++ b/docs/reference/models/rtdetr/val.md @@ -7,7 +7,7 @@ keywords: Ultralytics, RTDETRDataset, RTDETRValidator, real-time object detectio !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.rtdetr.val.RTDETRDataset diff --git a/docs/reference/models/sam/amg.md b/docs/reference/models/sam/amg.md index 625dba0c..c32986a8 100644 --- a/docs/reference/models/sam/amg.md +++ b/docs/reference/models/sam/amg.md @@ -7,7 +7,7 @@ keywords: Ultralytics, Mask Data, Transformation, Encoding, RLE encoding, Image !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.sam.amg.MaskData diff --git a/docs/reference/models/sam/build.md b/docs/reference/models/sam/build.md index 523b24c6..0b108c67 100644 --- a/docs/reference/models/sam/build.md +++ b/docs/reference/models/sam/build.md @@ -7,7 +7,7 @@ keywords: Ultralytics, SAM, build sam, vision transformer, vits, build_sam_vit_l !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.sam.build.build_sam_vit_h diff --git a/docs/reference/models/sam/model.md b/docs/reference/models/sam/model.md index b55c7d5e..974a9fd4 100644 --- a/docs/reference/models/sam/model.md +++ b/docs/reference/models/sam/model.md @@ -7,7 +7,7 @@ keywords: Ultralytics, YOLO, SAM Model, Documentations, Machine Learning, AI, Co !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.sam.model.SAM diff --git a/docs/reference/models/sam/modules/decoders.md b/docs/reference/models/sam/modules/decoders.md index d1fb7d23..48d5cf0f 100644 --- a/docs/reference/models/sam/modules/decoders.md +++ b/docs/reference/models/sam/modules/decoders.md @@ -7,7 +7,7 @@ keywords: Ultralytics, MaskDecoder, SAM modules, decoders, MLP, YOLO, machine le !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.sam.modules.decoders.MaskDecoder diff --git a/docs/reference/models/sam/modules/encoders.md b/docs/reference/models/sam/modules/encoders.md index 867c5ca3..406d257a 100644 --- a/docs/reference/models/sam/modules/encoders.md +++ b/docs/reference/models/sam/modules/encoders.md @@ -7,7 +7,7 @@ keywords: Ultralytics, Encoders, Modules, Documentation, ImageEncoderViT, Positi !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.sam.modules.encoders.ImageEncoderViT diff --git a/docs/reference/models/sam/modules/sam.md b/docs/reference/models/sam/modules/sam.md index add5e5ec..d13d55e2 100644 --- a/docs/reference/models/sam/modules/sam.md +++ b/docs/reference/models/sam/modules/sam.md @@ -7,7 +7,7 @@ keywords: Ultralytics, Sam module, deep learning, model training, Ultralytics do !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.sam.modules.sam.Sam diff --git a/docs/reference/models/sam/modules/tiny_encoder.md b/docs/reference/models/sam/modules/tiny_encoder.md index f2208f06..e9986217 100644 --- a/docs/reference/models/sam/modules/tiny_encoder.md +++ b/docs/reference/models/sam/modules/tiny_encoder.md @@ -7,7 +7,7 @@ keywords: Ultralytics, Tiny Encoder, Conv2d_BN, MBConv, ConvLayer, Attention, Ba !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.sam.modules.tiny_encoder.Conv2d_BN diff --git a/docs/reference/models/sam/modules/transformer.md b/docs/reference/models/sam/modules/transformer.md index b635a931..50f75f14 100644 --- a/docs/reference/models/sam/modules/transformer.md +++ b/docs/reference/models/sam/modules/transformer.md @@ -7,7 +7,7 @@ keywords: Ultralytics, TwoWayTransformer, Attention, AI models, transformers !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.sam.modules.transformer.TwoWayTransformer diff --git a/docs/reference/models/sam/predict.md b/docs/reference/models/sam/predict.md index ea427e95..5c4e9b6a 100644 --- a/docs/reference/models/sam/predict.md +++ b/docs/reference/models/sam/predict.md @@ -7,7 +7,7 @@ keywords: Ultralytics, predictor, models, sam.predict.Predictor, AI, machine lea !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.sam.predict.Predictor diff --git a/docs/reference/models/utils/loss.md b/docs/reference/models/utils/loss.md index 386ab723..18ca92a9 100644 --- a/docs/reference/models/utils/loss.md +++ b/docs/reference/models/utils/loss.md @@ -7,7 +7,7 @@ keywords: Ultralytics, YOLO, Documentation, DETRLoss, Detection Loss, Loss funct !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.utils.loss.DETRLoss diff --git a/docs/reference/models/utils/ops.md b/docs/reference/models/utils/ops.md index fe353f0f..b2c19a30 100644 --- a/docs/reference/models/utils/ops.md +++ b/docs/reference/models/utils/ops.md @@ -7,7 +7,7 @@ keywords: Ultralytics, YOLO, HungarianMatcher, inverse_sigmoid, detection models !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.utils.ops.HungarianMatcher diff --git a/docs/reference/models/yolo/classify/predict.md b/docs/reference/models/yolo/classify/predict.md index a8d03ddf..f2eaa511 100644 --- a/docs/reference/models/yolo/classify/predict.md +++ b/docs/reference/models/yolo/classify/predict.md @@ -7,7 +7,7 @@ keywords: Ultralytics, classification predictor, predict, YOLO, AI models, model !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.yolo.classify.predict.ClassificationPredictor diff --git a/docs/reference/models/yolo/classify/train.md b/docs/reference/models/yolo/classify/train.md index c3dfba11..74dffed3 100644 --- a/docs/reference/models/yolo/classify/train.md +++ b/docs/reference/models/yolo/classify/train.md @@ -7,7 +7,7 @@ keywords: Ultralytics, YOLO, Classification Trainer, deep learning, training pro !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.yolo.classify.train.ClassificationTrainer diff --git a/docs/reference/models/yolo/classify/val.md b/docs/reference/models/yolo/classify/val.md index b7613558..8aadbf04 100644 --- a/docs/reference/models/yolo/classify/val.md +++ b/docs/reference/models/yolo/classify/val.md @@ -7,7 +7,7 @@ keywords: Ultralytics, YOLO, ClassificationValidator, model validation, model fi !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.yolo.classify.val.ClassificationValidator diff --git a/docs/reference/models/yolo/detect/predict.md b/docs/reference/models/yolo/detect/predict.md index 31325bc2..764b7b14 100644 --- a/docs/reference/models/yolo/detect/predict.md +++ b/docs/reference/models/yolo/detect/predict.md @@ -7,7 +7,7 @@ keywords: Ultralytics, YOLO, DetectionPredictor, detect, predict, object detecti !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.yolo.detect.predict.DetectionPredictor diff --git a/docs/reference/models/yolo/detect/train.md b/docs/reference/models/yolo/detect/train.md index bee758ec..cff7240d 100644 --- a/docs/reference/models/yolo/detect/train.md +++ b/docs/reference/models/yolo/detect/train.md @@ -7,7 +7,7 @@ keywords: Ultralytics YOLO, YOLO, Detection Trainer, Model Training, Machine Lea !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.yolo.detect.train.DetectionTrainer diff --git a/docs/reference/models/yolo/detect/val.md b/docs/reference/models/yolo/detect/val.md index 0b51b451..425e7dba 100644 --- a/docs/reference/models/yolo/detect/val.md +++ b/docs/reference/models/yolo/detect/val.md @@ -7,7 +7,7 @@ keywords: Ultralytics, YOLO, Detection Validator, model valuation, precision, re !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.yolo.detect.val.DetectionValidator diff --git a/docs/reference/models/yolo/model.md b/docs/reference/models/yolo/model.md index 2121a056..4f8e4c73 100644 --- a/docs/reference/models/yolo/model.md +++ b/docs/reference/models/yolo/model.md @@ -7,7 +7,7 @@ keywords: Ultralytics YOLO, YOLO, YOLO model, Model Training, Machine Learning, !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.yolo.model.YOLO diff --git a/docs/reference/models/yolo/pose/predict.md b/docs/reference/models/yolo/pose/predict.md index 1c090939..a82e622c 100644 --- a/docs/reference/models/yolo/pose/predict.md +++ b/docs/reference/models/yolo/pose/predict.md @@ -7,7 +7,7 @@ keywords: Ultralytics, YOLO, PosePredictor, machine learning, AI, predictive mod !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.yolo.pose.predict.PosePredictor diff --git a/docs/reference/models/yolo/pose/train.md b/docs/reference/models/yolo/pose/train.md index 5f6ad697..b9f79eba 100644 --- a/docs/reference/models/yolo/pose/train.md +++ b/docs/reference/models/yolo/pose/train.md @@ -7,7 +7,7 @@ keywords: Ultralytics, YOLO, PoseTrainer, pose training, AI modeling, custom dat !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.yolo.pose.train.PoseTrainer diff --git a/docs/reference/models/yolo/pose/val.md b/docs/reference/models/yolo/pose/val.md index c1312357..6df09ddc 100644 --- a/docs/reference/models/yolo/pose/val.md +++ b/docs/reference/models/yolo/pose/val.md @@ -7,7 +7,7 @@ keywords: PoseValidator, Ultralytics, YOLO, Object detection, Pose validation !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.yolo.pose.val.PoseValidator diff --git a/docs/reference/models/yolo/segment/predict.md b/docs/reference/models/yolo/segment/predict.md index a9ad69e1..9e7e146c 100644 --- a/docs/reference/models/yolo/segment/predict.md +++ b/docs/reference/models/yolo/segment/predict.md @@ -7,7 +7,7 @@ keywords: YOLO, Ultralytics, object detection, segmentation predictor !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.yolo.segment.predict.SegmentationPredictor diff --git a/docs/reference/models/yolo/segment/train.md b/docs/reference/models/yolo/segment/train.md index 9c4dc872..b91f575e 100644 --- a/docs/reference/models/yolo/segment/train.md +++ b/docs/reference/models/yolo/segment/train.md @@ -7,7 +7,7 @@ keywords: Ultralytics, YOLO, SegmentationTrainer, image segmentation, object det !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.yolo.segment.train.SegmentationTrainer diff --git a/docs/reference/models/yolo/segment/val.md b/docs/reference/models/yolo/segment/val.md index 898090a7..c372a7fc 100644 --- a/docs/reference/models/yolo/segment/val.md +++ b/docs/reference/models/yolo/segment/val.md @@ -7,7 +7,7 @@ keywords: Ultralytics, YOLO, SegmentationValidator, model segmentation, image cl !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.models.yolo.segment.val.SegmentationValidator diff --git a/docs/reference/nn/autobackend.md b/docs/reference/nn/autobackend.md index af21d60b..7d04c156 100644 --- a/docs/reference/nn/autobackend.md +++ b/docs/reference/nn/autobackend.md @@ -7,7 +7,7 @@ keywords: Ultralytics, AutoBackend, check_class_names, YOLO, YOLO models, optimi !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.nn.autobackend.AutoBackend diff --git a/docs/reference/nn/modules/block.md b/docs/reference/nn/modules/block.md index ae72e3be..2fca5120 100644 --- a/docs/reference/nn/modules/block.md +++ b/docs/reference/nn/modules/block.md @@ -7,7 +7,7 @@ keywords: YOLO, Ultralytics, neural network, nn.modules.block, Proto, HGBlock, S !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.nn.modules.block.DFL diff --git a/docs/reference/nn/modules/conv.md b/docs/reference/nn/modules/conv.md index bf83f8ab..1ce4d642 100644 --- a/docs/reference/nn/modules/conv.md +++ b/docs/reference/nn/modules/conv.md @@ -7,7 +7,7 @@ keywords: Ultralytics, Convolution Modules, Conv2, DWConv, ConvTranspose, GhostC !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.nn.modules.conv.Conv diff --git a/docs/reference/nn/modules/head.md b/docs/reference/nn/modules/head.md index bbbeab93..7b3a1378 100644 --- a/docs/reference/nn/modules/head.md +++ b/docs/reference/nn/modules/head.md @@ -7,7 +7,7 @@ keywords: Ultralytics, YOLO, Detection, Pose, RTDETRDecoder, nn modules, guides !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.nn.modules.head.Detect diff --git a/docs/reference/nn/modules/transformer.md b/docs/reference/nn/modules/transformer.md index be689a1d..716078fd 100644 --- a/docs/reference/nn/modules/transformer.md +++ b/docs/reference/nn/modules/transformer.md @@ -7,7 +7,7 @@ keywords: Ultralytics, Ultralytics documentation, TransformerEncoderLayer, Trans !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.nn.modules.transformer.TransformerEncoderLayer diff --git a/docs/reference/nn/modules/utils.md b/docs/reference/nn/modules/utils.md index 1604e77a..51741f98 100644 --- a/docs/reference/nn/modules/utils.md +++ b/docs/reference/nn/modules/utils.md @@ -7,7 +7,7 @@ keywords: Ultralytics, neural network, nn.modules.utils, bias_init_with_prob, in !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.nn.modules.utils._get_clones diff --git a/docs/reference/nn/tasks.md b/docs/reference/nn/tasks.md index 52c1ab76..c690ff40 100644 --- a/docs/reference/nn/tasks.md +++ b/docs/reference/nn/tasks.md @@ -2,7 +2,7 @@ !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.nn.tasks.BaseModel diff --git a/docs/reference/trackers/basetrack.md b/docs/reference/trackers/basetrack.md index 858db47a..9d84bbb6 100644 --- a/docs/reference/trackers/basetrack.md +++ b/docs/reference/trackers/basetrack.md @@ -7,7 +7,7 @@ keywords: Ultralytics, TrackState, BaseTrack, Ultralytics tracker, Ultralytics d !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.trackers.basetrack.TrackState diff --git a/docs/reference/trackers/bot_sort.md b/docs/reference/trackers/bot_sort.md index 7aac57eb..2b8886de 100644 --- a/docs/reference/trackers/bot_sort.md +++ b/docs/reference/trackers/bot_sort.md @@ -7,7 +7,7 @@ keywords: Ultralytics, BOTSORT, BOTrack, tracking system, official documentation !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.trackers.bot_sort.BOTrack diff --git a/docs/reference/trackers/byte_tracker.md b/docs/reference/trackers/byte_tracker.md index 24cc3442..712204f7 100644 --- a/docs/reference/trackers/byte_tracker.md +++ b/docs/reference/trackers/byte_tracker.md @@ -7,7 +7,7 @@ keywords: STrack, Ultralytics, BYTETracker, documentation, Ultralytics tracker, !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.trackers.byte_tracker.STrack diff --git a/docs/reference/trackers/track.md b/docs/reference/trackers/track.md index 3fbf3e88..a2bf52d9 100644 --- a/docs/reference/trackers/track.md +++ b/docs/reference/trackers/track.md @@ -7,7 +7,7 @@ keywords: Ultralytics, YOLO, on predict start, register tracker, prediction func !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.trackers.track.on_predict_start diff --git a/docs/reference/trackers/utils/gmc.md b/docs/reference/trackers/utils/gmc.md index 3365e119..c49c149a 100644 --- a/docs/reference/trackers/utils/gmc.md +++ b/docs/reference/trackers/utils/gmc.md @@ -7,7 +7,7 @@ keywords: Ultralytics, GMC utility, Ultralytics documentation, Ultralytics track !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.trackers.utils.gmc.GMC diff --git a/docs/reference/trackers/utils/kalman_filter.md b/docs/reference/trackers/utils/kalman_filter.md index 75667e8d..e18db7f0 100644 --- a/docs/reference/trackers/utils/kalman_filter.md +++ b/docs/reference/trackers/utils/kalman_filter.md @@ -7,7 +7,7 @@ keywords: Ultralytics, KalmanFilterXYAH, tracker, documentation, guide !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.trackers.utils.kalman_filter.KalmanFilterXYAH diff --git a/docs/reference/trackers/utils/matching.md b/docs/reference/trackers/utils/matching.md index 290b8a2e..50a796c3 100644 --- a/docs/reference/trackers/utils/matching.md +++ b/docs/reference/trackers/utils/matching.md @@ -7,7 +7,7 @@ keywords: Ultralytics, Trackers Utils, Matching, merge_matches, linear_assignmen !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.trackers.utils.matching.merge_matches diff --git a/docs/reference/utils/__init__.md b/docs/reference/utils/__init__.md index 83fa71c9..377790b8 100644 --- a/docs/reference/utils/__init__.md +++ b/docs/reference/utils/__init__.md @@ -3,11 +3,11 @@ description: Explore the Ultralytics Utils package, with handy functions like co keywords: Ultralytics, Utils, utilitarian functions, colorstr, yaml_save, set_logging, is_kaggle, is_docker, clean_url --- -# Reference for `ultralytics/utils.py` +# Reference for `ultralytics/utils/__init__.py` !!! note - Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils.py). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.SimpleClass diff --git a/docs/reference/utils/autobatch.md b/docs/reference/utils/autobatch.md index cdcdd085..aa0f1861 100644 --- a/docs/reference/utils/autobatch.md +++ b/docs/reference/utils/autobatch.md @@ -7,7 +7,7 @@ keywords: Ultralytics, check_train_batch_size, autobatch, utility, machine learn !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.autobatch.check_train_batch_size diff --git a/docs/reference/utils/benchmarks.md b/docs/reference/utils/benchmarks.md index 4b96053c..ec805522 100644 --- a/docs/reference/utils/benchmarks.md +++ b/docs/reference/utils/benchmarks.md @@ -7,7 +7,7 @@ keywords: Ultralytics, ProfileModels, benchmarks, model profiling, performance o !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.benchmarks.ProfileModels diff --git a/docs/reference/utils/callbacks/base.md b/docs/reference/utils/callbacks/base.md index 36509d7f..22f85920 100644 --- a/docs/reference/utils/callbacks/base.md +++ b/docs/reference/utils/callbacks/base.md @@ -7,7 +7,7 @@ keywords: Ultralytics, Callbacks, On-train, On-validation, On-pretrain, On-predi !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.callbacks.base.on_pretrain_routine_start diff --git a/docs/reference/utils/callbacks/clearml.md b/docs/reference/utils/callbacks/clearml.md index 7bac81f3..c161ca96 100644 --- a/docs/reference/utils/callbacks/clearml.md +++ b/docs/reference/utils/callbacks/clearml.md @@ -7,7 +7,7 @@ keywords: Ultralytics, clearML, callbacks, pretrain routine start, validation en !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.callbacks.clearml._log_debug_samples diff --git a/docs/reference/utils/callbacks/comet.md b/docs/reference/utils/callbacks/comet.md index 603c714b..756ebb0f 100644 --- a/docs/reference/utils/callbacks/comet.md +++ b/docs/reference/utils/callbacks/comet.md @@ -7,7 +7,7 @@ keywords: Ultralytics, Comet Callbacks, Training optimisation, Logging, Experime !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.callbacks.comet._get_comet_mode diff --git a/docs/reference/utils/callbacks/dvc.md b/docs/reference/utils/callbacks/dvc.md index c5e52c34..23dcf228 100644 --- a/docs/reference/utils/callbacks/dvc.md +++ b/docs/reference/utils/callbacks/dvc.md @@ -7,7 +7,7 @@ keywords: Ultralytics, YOLO, callbacks, logger, training, pretraining, machine l !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.callbacks.dvc._logger_disabled diff --git a/docs/reference/utils/callbacks/hub.md b/docs/reference/utils/callbacks/hub.md index b5d3c88e..2355bf43 100644 --- a/docs/reference/utils/callbacks/hub.md +++ b/docs/reference/utils/callbacks/hub.md @@ -7,7 +7,7 @@ keywords: Ultralytics, callbacks, on_pretrain_routine_end, on_model_save, on_tra !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.callbacks.hub.on_pretrain_routine_end diff --git a/docs/reference/utils/callbacks/mlflow.md b/docs/reference/utils/callbacks/mlflow.md index 0eaba240..09135a6a 100644 --- a/docs/reference/utils/callbacks/mlflow.md +++ b/docs/reference/utils/callbacks/mlflow.md @@ -7,7 +7,7 @@ keywords: Ultralytics, MLflow, Callbacks, on_pretrain_routine_end, on_train_end, !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.callbacks.mlflow.on_pretrain_routine_end diff --git a/docs/reference/utils/callbacks/neptune.md b/docs/reference/utils/callbacks/neptune.md index 914f12bb..98295fef 100644 --- a/docs/reference/utils/callbacks/neptune.md +++ b/docs/reference/utils/callbacks/neptune.md @@ -7,7 +7,7 @@ keywords: Ultralytics, Neptune callbacks, on_train_epoch_end, on_val_end, _log_p !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.callbacks.neptune._log_scalars diff --git a/docs/reference/utils/callbacks/raytune.md b/docs/reference/utils/callbacks/raytune.md index 7c21782f..4ccc1921 100644 --- a/docs/reference/utils/callbacks/raytune.md +++ b/docs/reference/utils/callbacks/raytune.md @@ -7,7 +7,7 @@ keywords: Ultralytics, YOLO, on_fit_epoch_end, callbacks, documentation, deep le !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.callbacks.raytune.on_fit_epoch_end diff --git a/docs/reference/utils/callbacks/tensorboard.md b/docs/reference/utils/callbacks/tensorboard.md index 078c2add..e8080e3a 100644 --- a/docs/reference/utils/callbacks/tensorboard.md +++ b/docs/reference/utils/callbacks/tensorboard.md @@ -7,7 +7,7 @@ keywords: Ultralytics, YOLO, documentation, callback utilities, log_scalars, on_ !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.callbacks.tensorboard._log_scalars diff --git a/docs/reference/utils/callbacks/wb.md b/docs/reference/utils/callbacks/wb.md index dc86469e..358623ca 100644 --- a/docs/reference/utils/callbacks/wb.md +++ b/docs/reference/utils/callbacks/wb.md @@ -7,7 +7,7 @@ keywords: Ultralytics, callbacks, _log_plots, on_fit_epoch_end, on_train_end !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.callbacks.wb._log_plots diff --git a/docs/reference/utils/checks.md b/docs/reference/utils/checks.md index 8921682c..2070a5fc 100644 --- a/docs/reference/utils/checks.md +++ b/docs/reference/utils/checks.md @@ -7,7 +7,7 @@ keywords: Ultralytics, utility checks, ASCII, check_version, pip_update, check_p !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.checks.is_ascii diff --git a/docs/reference/utils/dist.md b/docs/reference/utils/dist.md index 16ecaea6..d0c5351c 100644 --- a/docs/reference/utils/dist.md +++ b/docs/reference/utils/dist.md @@ -7,7 +7,7 @@ keywords: Ultralytics, DDP, DDP utility functions, Distributed Data Processing, !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.dist.find_free_network_port diff --git a/docs/reference/utils/downloads.md b/docs/reference/utils/downloads.md index 297f79b6..74d6788a 100644 --- a/docs/reference/utils/downloads.md +++ b/docs/reference/utils/downloads.md @@ -7,7 +7,7 @@ keywords: Ultralytics, YOLO, download utilities, is_url, check_disk_space, get_g !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.downloads.is_url diff --git a/docs/reference/utils/errors.md b/docs/reference/utils/errors.md index aa8efc24..6faac36b 100644 --- a/docs/reference/utils/errors.md +++ b/docs/reference/utils/errors.md @@ -7,7 +7,7 @@ keywords: Ultralytics, HUBModelError, Machine Learning, Error troubleshooting, U !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.errors.HUBModelError diff --git a/docs/reference/utils/files.md b/docs/reference/utils/files.md index 68bbc57e..a6576923 100644 --- a/docs/reference/utils/files.md +++ b/docs/reference/utils/files.md @@ -7,7 +7,7 @@ keywords: Ultralytics, utility functions, file operations, working directory, fi !!! note - Full source code for 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). + Full source code for 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). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.files.WorkingDirectory diff --git a/docs/reference/utils/instance.md b/docs/reference/utils/instance.md index 6651fa74..fe8be3bf 100644 --- a/docs/reference/utils/instance.md +++ b/docs/reference/utils/instance.md @@ -7,7 +7,7 @@ keywords: Ultralytics, Bboxes, _ntuple, utility, ultralytics utils.instance !!! note - Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/instance.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/instance.py). + Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/instance.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/instance.py). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.instance.Bboxes diff --git a/docs/reference/utils/loss.md b/docs/reference/utils/loss.md index c72352b1..56efedd2 100644 --- a/docs/reference/utils/loss.md +++ b/docs/reference/utils/loss.md @@ -7,7 +7,7 @@ keywords: Ultralytics, Loss functions, VarifocalLoss, BboxLoss, v8DetectionLoss, !!! note - Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/loss.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/loss.py). + Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/loss.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/loss.py). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.loss.VarifocalLoss diff --git a/docs/reference/utils/metrics.md b/docs/reference/utils/metrics.md index ad0f5ce0..1da54888 100644 --- a/docs/reference/utils/metrics.md +++ b/docs/reference/utils/metrics.md @@ -7,7 +7,7 @@ keywords: Ultralytics, YOLO, YOLOv3, YOLOv4, metrics, confusion matrix, detectio !!! note - Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/metrics.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/metrics.py). + Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/metrics.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/metrics.py). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.metrics.ConfusionMatrix diff --git a/docs/reference/utils/ops.md b/docs/reference/utils/ops.md index 062f6383..8d4fd350 100644 --- a/docs/reference/utils/ops.md +++ b/docs/reference/utils/ops.md @@ -7,7 +7,7 @@ keywords: Ultralytics YOLO, Utility Operations, segment2box, make_divisible, cli !!! note - Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/ops.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/ops.py). + Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/ops.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/ops.py). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.ops.Profile diff --git a/docs/reference/utils/patches.md b/docs/reference/utils/patches.md index c4a5e5d0..7964d623 100644 --- a/docs/reference/utils/patches.md +++ b/docs/reference/utils/patches.md @@ -7,7 +7,7 @@ keywords: Ultralytics, Utils, Patches, imread, imshow, torch_save, image process !!! note - Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/patches.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/patches.py). + Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/patches.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/patches.py). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.patches.imread diff --git a/docs/reference/utils/plotting.md b/docs/reference/utils/plotting.md index 94d7494b..b7b3ea2b 100644 --- a/docs/reference/utils/plotting.md +++ b/docs/reference/utils/plotting.md @@ -7,7 +7,7 @@ keywords: Ultralytics, plotting, utils, color annotation, label plotting, image !!! note - Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/plotting.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/plotting.py). + Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/plotting.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/plotting.py). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.plotting.Colors diff --git a/docs/reference/utils/tal.md b/docs/reference/utils/tal.md index 2eba458c..bea38abe 100644 --- a/docs/reference/utils/tal.md +++ b/docs/reference/utils/tal.md @@ -7,7 +7,7 @@ keywords: Ultralytics, task aligned assigner, select highest overlaps, make anch !!! note - Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/tal.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/tal.py). + Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/tal.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/tal.py). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.tal.TaskAlignedAssigner diff --git a/docs/reference/utils/torch_utils.md b/docs/reference/utils/torch_utils.md index de4bb1ed..3a808a10 100644 --- a/docs/reference/utils/torch_utils.md +++ b/docs/reference/utils/torch_utils.md @@ -7,7 +7,7 @@ keywords: Ultralytics, Torch Utils, Model EMA, Early Stopping, Smart Inference, !!! note - Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/torch_utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/torch_utils.py). + Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/torch_utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/torch_utils.py). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.torch_utils.ModelEMA diff --git a/docs/reference/utils/tuner.md b/docs/reference/utils/tuner.md index d51906f5..a03ea221 100644 --- a/docs/reference/utils/tuner.md +++ b/docs/reference/utils/tuner.md @@ -7,7 +7,7 @@ keywords: Ultralytics, run_ray_tune, machine learning tuning, machine learning e !!! note - Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/tuner.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/tuner.py). + Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/tuner.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/tuner.py). Help us fix any issues you see by submitting a [Pull Request](/help/contributing/) 🛠️. Thank you 🙏! --- ## ::: ultralytics.utils.tuner.run_ray_tune diff --git a/ultralytics/cfg/__init__.py b/ultralytics/cfg/__init__.py index 111fd247..67f8fb85 100644 --- a/ultralytics/cfg/__init__.py +++ b/ultralytics/cfg/__init__.py @@ -222,7 +222,7 @@ def handle_yolo_hub(args: List[str]) -> None: args (List[str]): A list of command line arguments Example: - ```python + ```bash python my_script.py hub login your_api_key ``` """ @@ -248,7 +248,7 @@ def handle_yolo_settings(args: List[str]) -> None: args (List[str]): A list of command line arguments for YOLO settings management. Example: - ```python + ```bash python my_script.py yolo settings reset ``` """ diff --git a/ultralytics/hub/__init__.py b/ultralytics/hub/__init__.py index 33bd5370..2ffd21ae 100644 --- a/ultralytics/hub/__init__.py +++ b/ultralytics/hub/__init__.py @@ -18,6 +18,7 @@ def login(api_key=''): Example: ```python from ultralytics import hub + hub.login('API_KEY') ``` """ @@ -31,6 +32,7 @@ def logout(): Example: ```python from ultralytics import hub + hub.logout() ``` """ diff --git a/ultralytics/utils/ops.py b/ultralytics/utils/ops.py index de20481b..b3e75ad1 100644 --- a/ultralytics/utils/ops.py +++ b/ultralytics/utils/ops.py @@ -62,6 +62,8 @@ def coco80_to_coco91_class(): # Example: ```python + import numpy as np + a = np.loadtxt('data/coco.names', dtype='str', delimiter='\n') b = np.loadtxt('data/coco_paper.names', dtype='str', delimiter='\n') x1 = [list(a[i] == b).index(True) + 1 for i in range(80)] # darknet to coco