Chiebot-Mirror
/
ultralytics
mirror of https://github.com/ultralytics/ultralytics.git
9
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

Engine Model and Results Docs improvements (#14564)

Browse Source 
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Felipe Parodi <fparodi@pennmedicine.upenn.edu>
pull/14390/head
Glenn Jocher 4 months ago committed by GitHub
parent e59376b55f
commit 291883a23f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
123 changed files with 3799 additions and 1378 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 5
      docs/build_reference.py
  2. 30
      docs/en/reference/cfg/__init__.md
  3. 2
      docs/en/reference/data/annotator.md
  4. 38
      docs/en/reference/data/augment.md
  5. 2
      docs/en/reference/data/base.md
  6. 16
      docs/en/reference/data/build.md
  7. 14
      docs/en/reference/data/converter.md
  8. 12
      docs/en/reference/data/dataset.md
  9. 4
      docs/en/reference/data/explorer/explorer.md
  10. 22
      docs/en/reference/data/explorer/gui/dash.md
  11. 10
      docs/en/reference/data/explorer/utils.md
  12. 16
      docs/en/reference/data/loaders.md
  13. 16
      docs/en/reference/data/split_dota.md
  14. 32
      docs/en/reference/data/utils.md
  15. 10
      docs/en/reference/engine/exporter.md
  16. 2
      docs/en/reference/engine/model.md
  17. 2
      docs/en/reference/engine/predictor.md
  18. 14
      docs/en/reference/engine/results.md
  19. 2
      docs/en/reference/engine/trainer.md
  20. 2
      docs/en/reference/engine/tuner.md
  21. 2
      docs/en/reference/engine/validator.md
  22. 14
      docs/en/reference/hub/__init__.md
  23. 2
      docs/en/reference/hub/auth.md
  24. 2
      docs/en/reference/hub/session.md
  25. 8
      docs/en/reference/hub/utils.md
  26. 2
      docs/en/reference/models/fastsam/model.md
  27. 2
      docs/en/reference/models/fastsam/predict.md
  28. 2
      docs/en/reference/models/fastsam/prompt.md
  29. 4
      docs/en/reference/models/fastsam/utils.md
  30. 2
      docs/en/reference/models/fastsam/val.md
  31. 2
      docs/en/reference/models/nas/model.md
  32. 2
      docs/en/reference/models/nas/predict.md
  33. 2
      docs/en/reference/models/nas/val.md
  34. 2
      docs/en/reference/models/rtdetr/model.md
  35. 2
      docs/en/reference/models/rtdetr/predict.md
  36. 2
      docs/en/reference/models/rtdetr/train.md
  37. 4
      docs/en/reference/models/rtdetr/val.md
  38. 22
      docs/en/reference/models/sam/amg.md
  39. 12
      docs/en/reference/models/sam/build.md
  40. 2
      docs/en/reference/models/sam/model.md
  41. 4
      docs/en/reference/models/sam/modules/decoders.md
  42. 20
      docs/en/reference/models/sam/modules/encoders.md
  43. 2
      docs/en/reference/models/sam/modules/sam.md
  44. 22
      docs/en/reference/models/sam/modules/tiny_encoder.md
  45. 6
      docs/en/reference/models/sam/modules/transformer.md
  46. 2
      docs/en/reference/models/sam/predict.md
  47. 4
      docs/en/reference/models/utils/loss.md
  48. 4
      docs/en/reference/models/utils/ops.md
  49. 2
      docs/en/reference/models/yolo/classify/predict.md
  50. 2
      docs/en/reference/models/yolo/classify/train.md
  51. 2
      docs/en/reference/models/yolo/classify/val.md
  52. 2
      docs/en/reference/models/yolo/detect/predict.md
  53. 2
      docs/en/reference/models/yolo/detect/train.md
  54. 2
      docs/en/reference/models/yolo/detect/val.md
  55. 4
      docs/en/reference/models/yolo/model.md
  56. 2
      docs/en/reference/models/yolo/obb/predict.md
  57. 2
      docs/en/reference/models/yolo/obb/train.md
  58. 2
      docs/en/reference/models/yolo/obb/val.md
  59. 2
      docs/en/reference/models/yolo/pose/predict.md
  60. 2
      docs/en/reference/models/yolo/pose/train.md
  61. 2
      docs/en/reference/models/yolo/pose/val.md
  62. 2
      docs/en/reference/models/yolo/segment/predict.md
  63. 2
      docs/en/reference/models/yolo/segment/train.md
  64. 2
      docs/en/reference/models/yolo/segment/val.md
  65. 4
      docs/en/reference/models/yolo/world/train.md
  66. 2
      docs/en/reference/models/yolo/world/train_world.md
  67. 6
      docs/en/reference/nn/autobackend.md
  68. 78
      docs/en/reference/nn/modules/block.md
  69. 28
      docs/en/reference/nn/modules/conv.md
  70. 16
      docs/en/reference/nn/modules/head.md
  71. 20
      docs/en/reference/nn/modules/transformer.md
  72. 10
      docs/en/reference/nn/modules/utils.md
  73. 34
      docs/en/reference/nn/tasks.md
  74. 2
      docs/en/reference/solutions/ai_gym.md
  75. 2
      docs/en/reference/solutions/analytics.md
  76. 2
      docs/en/reference/solutions/distance_calculation.md
  77. 2
      docs/en/reference/solutions/heatmap.md
  78. 2
      docs/en/reference/solutions/object_counter.md
  79. 4
      docs/en/reference/solutions/parking_management.md
  80. 2
      docs/en/reference/solutions/queue_management.md
  81. 2
      docs/en/reference/solutions/speed_estimation.md
  82. 2
      docs/en/reference/solutions/streamlit_inference.md
  83. 4
      docs/en/reference/trackers/basetrack.md
  84. 4
      docs/en/reference/trackers/bot_sort.md
  85. 4
      docs/en/reference/trackers/byte_tracker.md
  86. 6
      docs/en/reference/trackers/track.md
  87. 2
      docs/en/reference/trackers/utils/gmc.md
  88. 4
      docs/en/reference/trackers/utils/kalman_filter.md
  89. 8
      docs/en/reference/trackers/utils/matching.md
  90. 80
      docs/en/reference/utils/__init__.md
  91. 4
      docs/en/reference/utils/autobatch.md
  92. 6
      docs/en/reference/utils/benchmarks.md
  93. 54
      docs/en/reference/utils/callbacks/base.md
  94. 14
      docs/en/reference/utils/callbacks/clearml.md
  95. 48
      docs/en/reference/utils/callbacks/comet.md
  96. 18
      docs/en/reference/utils/callbacks/dvc.md
  97. 18
      docs/en/reference/utils/callbacks/hub.md
  98. 10
      docs/en/reference/utils/callbacks/mlflow.md
  99. 16
      docs/en/reference/utils/callbacks/neptune.md
  100. 2
      docs/en/reference/utils/callbacks/raytune.md
  101. Some files were not shown because too many files have changed in this diff Show More

5
docs/build_reference.py
Unescape View File

@ -63,8 +63,9 @@ def create_markdown(py_filepath: Path, module_path: str, classes: list, function
f" This file is available at [{pretty}]({url}). If you spot a problem please help fix it by [contributing]"
f"(https://docs.ultralytics.com/help/contributing/) a [Pull Request]({edit}) 🛠️. Thank you 🙏!\n\n"
)
md_content = ["<br><br>\n"] + [f"## ::: {module_name}.{class_name}\n\n<br><br>\n" for class_name in classes]
md_content.extend(f"## ::: {module_name}.{func_name}\n\n<br><br>\n" for func_name in functions)
md_content = ["<br>\n"] + [f"## ::: {module_name}.{class_name}\n\n<br><br><hr><br>\n" for class_name in classes]
md_content.extend(f"## ::: {module_name}.{func_name}\n\n<br><br><hr><br>\n" for func_name in functions)
md_content[-1] = md_content[-1].replace("<hr><br>", "") # remove last horizontal line
md_content = header_content + title_content + "\n".join(md_content)
if not md_content.endswith("\n"):
md_content += "\n"

30
docs/en/reference/cfg/__init__.md
Unescape View File

@ -9,63 +9,63 @@ keywords: Ultralytics, YOLO, configuration, cfg2dict, get_cfg, check_cfg, save_d
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>
<br>
## ::: ultralytics.cfg.cfg2dict
<br><br>
<br><br><hr><br>
## ::: ultralytics.cfg.get_cfg
<br><br>
<br><br><hr><br>
## ::: ultralytics.cfg.check_cfg
<br><br>
<br><br><hr><br>
## ::: ultralytics.cfg.get_save_dir
<br><br>
<br><br><hr><br>
## ::: ultralytics.cfg._handle_deprecation
<br><br>
<br><br><hr><br>
## ::: ultralytics.cfg.check_dict_alignment
<br><br>
<br><br><hr><br>
## ::: ultralytics.cfg.merge_equals_args
<br><br>
<br><br><hr><br>
## ::: ultralytics.cfg.handle_yolo_hub
<br><br>
<br><br><hr><br>
## ::: ultralytics.cfg.handle_yolo_settings
<br><br>
<br><br><hr><br>
## ::: ultralytics.cfg.handle_explorer
<br><br>
<br><br><hr><br>
## ::: ultralytics.cfg.handle_streamlit_inference
<br><br>
<br><br><hr><br>
## ::: ultralytics.cfg.parse_key_value_pair
<br><br>
<br><br><hr><br>
## ::: ultralytics.cfg.smart_value
<br><br>
<br><br><hr><br>
## ::: ultralytics.cfg.entrypoint
<br><br>
<br><br><hr><br>
## ::: ultralytics.cfg.copy_default_cfg

2
docs/en/reference/data/annotator.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, image annotation, YOLO, SAM, Python script, GitHub, objec
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>
<br>
## ::: ultralytics.data.annotator.auto_annotate

38
docs/en/reference/data/augment.md
Unescape View File

@ -9,79 +9,79 @@ keywords: Ultralytics, image augmentation, MixUp, Mosaic, Random Perspective, de
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>
<br>
## ::: ultralytics.data.augment.BaseTransform
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.Compose
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.BaseMixTransform
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.Mosaic
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.MixUp
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.RandomPerspective
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.RandomHSV
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.RandomFlip
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.LetterBox
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.CopyPaste
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.Albumentations
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.Format
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.RandomLoadText
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.ClassifyLetterBox
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.CenterCrop
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.ToTensor
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.v8_transforms
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.classify_transforms
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.classify_augmentations

2
docs/en/reference/data/base.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, BaseDataset, image processing, data augmentation, YOLO, d
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>
<br>
## ::: ultralytics.data.base.BaseDataset

16
docs/en/reference/data/build.md
Unescape View File

@ -9,35 +9,35 @@ keywords: Ultralytics, Data Builders, InfiniteDataLoader, YOLO dataset, build.py
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>
<br>
## ::: ultralytics.data.build.InfiniteDataLoader
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.build._RepeatSampler
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.build.seed_worker
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.build.build_yolo_dataset
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.build.build_grounding
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.build.build_dataloader
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.build.check_source
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.build.load_inference_source

14
docs/en/reference/data/converter.md
Unescape View File

@ -9,31 +9,31 @@ keywords: Ultralytics, data conversion, YOLO models, COCO, DOTA, YOLO bbox2segme
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>
<br>
## ::: ultralytics.data.converter.coco91_to_coco80_class
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.converter.coco80_to_coco91_class
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.converter.convert_coco
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.converter.convert_dota_to_yolo_obb
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.converter.min_index
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.converter.merge_multi_segment
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.converter.yolo_bbox2segment

12
docs/en/reference/data/dataset.md
Unescape View File

@ -9,27 +9,27 @@ keywords: Ultralytics, YOLODataset, object detection, segmentation, dataset load
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>
<br>
## ::: ultralytics.data.dataset.YOLODataset
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.dataset.YOLOMultiModalDataset
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.dataset.GroundingDataset
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.dataset.YOLOConcatDataset
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.dataset.SemanticDataset
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.dataset.ClassificationDataset

4
docs/en/reference/data/explorer/explorer.md
Unescape View File

@ -10,11 +10,11 @@ keywords: Ultralytics, YOLO, data explorer, image querying, embeddings, similari
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>
<br>
## ::: ultralytics.data.explorer.explorer.ExplorerDataset
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.explorer.Explorer

22
docs/en/reference/data/explorer/gui/dash.md
Unescape View File

@ -10,47 +10,47 @@ keywords: Ultralytics, Explorer, GUI, dash, documentation, data explorer, AI que
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>
<br>
## ::: ultralytics.data.explorer.gui.dash._get_explorer
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.gui.dash.init_explorer_form
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.gui.dash.query_form
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.gui.dash.ai_query_form
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.gui.dash.find_similar_imgs
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.gui.dash.similarity_form
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.gui.dash.run_sql_query
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.gui.dash.run_ai_query
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.gui.dash.reset_explorer
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.gui.dash.utralytics_explorer_docs_callback
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.gui.dash.layout

10
docs/en/reference/data/explorer/utils.md
Unescape View File

@ -10,23 +10,23 @@ keywords: Ultralytics, data explorer, utils, schema, sanitize batch, plot query
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>
<br>
## ::: ultralytics.data.explorer.utils.get_table_schema
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.utils.get_sim_index_schema
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.utils.sanitize_batch
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.utils.plot_query_result
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.utils.prompt_sql_query

16
docs/en/reference/data/loaders.md
Unescape View File

@ -9,35 +9,35 @@ keywords: Ultralytics, data loaders, SourceTypes, LoadStreams, LoadScreenshots,
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>
<br>
## ::: ultralytics.data.loaders.SourceTypes
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.loaders.LoadStreams
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.loaders.LoadScreenshots
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.loaders.LoadImagesAndVideos
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.loaders.LoadPilAndNumpy
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.loaders.LoadTensor
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.loaders.autocast_list
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.loaders.get_best_youtube_url

16
docs/en/reference/data/split_dota.md
Unescape View File

@ -9,35 +9,35 @@ keywords: Ultralytics, DOTA dataset, data splitting, YOLO, Python, bbox_iof, loa
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>
<br>
## ::: ultralytics.data.split_dota.bbox_iof
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.split_dota.load_yolo_dota
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.split_dota.get_windows
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.split_dota.get_window_obj
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.split_dota.crop_and_save
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.split_dota.split_images_and_labels
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.split_dota.split_trainval
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.split_dota.split_test

32
docs/en/reference/data/utils.md
Unescape View File

@ -9,67 +9,67 @@ keywords: Ultralytics, dataset utils, data handling, image verification, Python,
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>
<br>
## ::: ultralytics.data.utils.HUBDatasetStats
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.img2label_paths
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.get_hash
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.exif_size
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.verify_image
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.verify_image_label
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.polygon2mask
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.polygons2masks
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.polygons2masks_overlap
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.find_dataset_yaml
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.check_det_dataset
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.check_cls_dataset
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.compress_one_image
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.autosplit
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.load_dataset_cache_file
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.save_dataset_cache_file

10
docs/en/reference/engine/exporter.md
Unescape View File

@ -9,23 +9,23 @@ keywords: YOLOv8, export formats, ONNX, TensorRT, CoreML, machine learning model
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>
<br>
## ::: ultralytics.engine.exporter.Exporter
<br><br>
<br><br><hr><br>
## ::: ultralytics.engine.exporter.IOSDetectModel
<br><br>
<br><br><hr><br>
## ::: ultralytics.engine.exporter.export_formats
<br><br>
<br><br><hr><br>
## ::: ultralytics.engine.exporter.gd_outputs
<br><br>
<br><br><hr><br>
## ::: ultralytics.engine.exporter.try_export

2
docs/en/reference/engine/model.md
Unescape View File

@ -9,7 +9,7 @@ keywords: YOLO model, Ultralytics, machine learning, deep learning, PyTorch mode
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>
<br>
## ::: ultralytics.engine.model.Model

2
docs/en/reference/engine/predictor.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, YOLO, Base Predictor, image inference, video inference, m
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>
<br>
## ::: ultralytics.engine.predictor.BasePredictor

14
docs/en/reference/engine/results.md
Unescape View File

@ -9,31 +9,31 @@ keywords: Ultralytics, engine results, BaseTensor, Results class, Boxes, Masks,
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>
<br>
## ::: ultralytics.engine.results.BaseTensor
<br><br>
<br><br><hr><br>
## ::: ultralytics.engine.results.Results
<br><br>
<br><br><hr><br>
## ::: ultralytics.engine.results.Boxes
<br><br>
<br><br><hr><br>
## ::: ultralytics.engine.results.Masks
<br><br>
<br><br><hr><br>
## ::: ultralytics.engine.results.Keypoints
<br><br>
<br><br><hr><br>
## ::: ultralytics.engine.results.Probs
<br><br>
<br><br><hr><br>
## ::: ultralytics.engine.results.OBB

2
docs/en/reference/engine/trainer.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, YOLO, BaseTrainer, model training, configuration, dataset
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>
<br>
## ::: ultralytics.engine.trainer.BaseTrainer

2
docs/en/reference/engine/tuner.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, YOLO, hyperparameter tuning, machine learning, deep learn
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>
<br>
## ::: ultralytics.engine.tuner.Tuner

2
docs/en/reference/engine/validator.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, BaseValidator, model validation, PyTorch, TensorFlow, ONN
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>
<br>
## ::: ultralytics.engine.validator.BaseValidator

14
docs/en/reference/hub/__init__.md
Unescape View File

@ -9,31 +9,31 @@ keywords: Ultralytics HUB API, login, logout, reset model, export model, check d
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>
<br>
## ::: ultralytics.hub.login
<br><br>
<br><br><hr><br>
## ::: ultralytics.hub.logout
<br><br>
<br><br><hr><br>
## ::: ultralytics.hub.reset_model
<br><br>
<br><br><hr><br>
## ::: ultralytics.hub.export_fmts_hub
<br><br>
<br><br><hr><br>
## ::: ultralytics.hub.export_model
<br><br>
<br><br><hr><br>
## ::: ultralytics.hub.get_export
<br><br>
<br><br><hr><br>
## ::: ultralytics.hub.check_dataset

2
docs/en/reference/hub/auth.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, authentication, API key, cookies, Auth class, YOLO, API,
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>
<br>
## ::: ultralytics.hub.auth.Auth

2
docs/en/reference/hub/session.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, YOLO, HUBTrainingSession, model training, heartbeats, che
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>
<br>
## ::: ultralytics.hub.session.HUBTrainingSession

8
docs/en/reference/hub/utils.md
Unescape View File

@ -9,19 +9,19 @@ keywords: Ultralytics, HUB, Utilities, YOLO, smart_request, request_with_credent
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>
<br>
## ::: ultralytics.hub.utils.Events
<br><br>
<br><br><hr><br>
## ::: ultralytics.hub.utils.request_with_credentials
<br><br>
<br><br><hr><br>
## ::: ultralytics.hub.utils.requests_with_progress
<br><br>
<br><br><hr><br>
## ::: ultralytics.hub.utils.smart_request

2
docs/en/reference/models/fastsam/model.md
Unescape View File

@ -9,7 +9,7 @@ keywords: FastSAM, Ultralytics, model interface, YOLO, deep learning, machine le
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>
<br>
## ::: ultralytics.models.fastsam.model.FastSAM

2
docs/en/reference/models/fastsam/predict.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, Fast SAM Predictor, YOLO, segmentation, prediction, AI mo
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>
<br>
## ::: ultralytics.models.fastsam.predict.FastSAMPredictor

2
docs/en/reference/models/fastsam/prompt.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, FastSAM, image annotation, image visualization, FastSAMPr
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>
<br>
## ::: ultralytics.models.fastsam.prompt.FastSAMPrompt

4
docs/en/reference/models/fastsam/utils.md
Unescape View File

@ -9,11 +9,11 @@ keywords: FastSAM, bounding boxes, IoU, Ultralytics, image processing, computer
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>
<br>
## ::: ultralytics.models.fastsam.utils.adjust_bboxes_to_image_border
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.fastsam.utils.bbox_iou

2
docs/en/reference/models/fastsam/val.md
Unescape View File

@ -9,7 +9,7 @@ keywords: FastSAM Validator, Ultralytics, YOLO, segmentation, validation, metric
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>
<br>
## ::: ultralytics.models.fastsam.val.FastSAMValidator

2
docs/en/reference/models/nas/model.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, YOLO, YOLO-NAS, object detection, pre-trained models, mac
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>
<br>
## ::: ultralytics.models.nas.model.NAS

2
docs/en/reference/models/nas/predict.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, YOLO, NASPredictor, object detection, machine learning, A
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>
<br>
## ::: ultralytics.models.nas.predict.NASPredictor

2
docs/en/reference/models/nas/val.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, YOLO, NASValidator, object detection, non-maximum suppres
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>
<br>
## ::: ultralytics.models.nas.val.NASValidator

2
docs/en/reference/models/rtdetr/model.md
Unescape View File

@ -9,7 +9,7 @@ keywords: RT-DETR, real-time object detection, Vision Transformer, Ultralytics,
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>
<br>
## ::: ultralytics.models.rtdetr.model.RTDETR

2
docs/en/reference/models/rtdetr/predict.md
Unescape View File

@ -9,7 +9,7 @@ keywords: RTDETRPredictor, Ultralytics, Real-Time Detection Transformer, object
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>
<br>
## ::: ultralytics.models.rtdetr.predict.RTDETRPredictor

2
docs/en/reference/models/rtdetr/train.md
Unescape View File

@ -9,7 +9,7 @@ keywords: RTDETRTrainer, real-time object detection, Vision Transformers, YOLO,
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>
<br>
## ::: ultralytics.models.rtdetr.train.RTDETRTrainer

4
docs/en/reference/models/rtdetr/val.md
Unescape View File

@ -9,11 +9,11 @@ keywords: RTDETR, Ultralytics, object detection, tracking, YOLO, RTDETRDataset,
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>
<br>
## ::: ultralytics.models.rtdetr.val.RTDETRDataset
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.rtdetr.val.RTDETRValidator

22
docs/en/reference/models/sam/amg.md
Unescape View File

@ -9,47 +9,47 @@ keywords: Ultralytics, SAM, AMG, API Reference, models, mask stability, crop box
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>
<br>
## ::: ultralytics.models.sam.amg.is_box_near_crop_edge
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.batch_iterator
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.calculate_stability_score
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.build_point_grid
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.build_all_layer_point_grids
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.generate_crop_boxes
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.uncrop_boxes_xyxy
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.uncrop_points
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.uncrop_masks
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.remove_small_regions
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.batched_mask_to_box

12
docs/en/reference/models/sam/build.md
Unescape View File

@ -9,27 +9,27 @@ keywords: Ultralytics, SAM model, Segment Anything Model, SAM ViT, Mobile-SAM, m
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>
<br>
## ::: ultralytics.models.sam.build.build_sam_vit_h
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.build.build_sam_vit_l
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.build.build_sam_vit_b
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.build.build_mobile_sam
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.build._build_sam
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.build.build_sam

2
docs/en/reference/models/sam/model.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, SAM, Segment Anything Model, image segmentation, real-tim
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>
<br>
## ::: ultralytics.models.sam.model.SAM

4
docs/en/reference/models/sam/modules/decoders.md
Unescape View File

@ -9,11 +9,11 @@ keywords: Ultralytics, MaskDecoder, MLP, machine learning, transformer architect
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>
<br>
## ::: ultralytics.models.sam.modules.decoders.MaskDecoder
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.decoders.MLP

20
docs/en/reference/models/sam/modules/encoders.md
Unescape View File

@ -9,43 +9,43 @@ keywords: Ultralytics, SAM encoder, ImageEncoderViT, PromptEncoder, PositionEmbe
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>
<br>
## ::: ultralytics.models.sam.modules.encoders.ImageEncoderViT
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.encoders.PromptEncoder
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.encoders.PositionEmbeddingRandom
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.encoders.Block
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.encoders.Attention
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.encoders.PatchEmbed
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.encoders.window_partition
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.encoders.window_unpartition
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.encoders.get_rel_pos
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.encoders.add_decomposed_rel_pos

2
docs/en/reference/models/sam/modules/sam.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, Sam Module, object segmentation, image encoder, mask deco
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>
<br>
## ::: ultralytics.models.sam.modules.sam.Sam

22
docs/en/reference/models/sam/modules/tiny_encoder.md
Unescape View File

@ -9,47 +9,47 @@ keywords: Ultralytics, TinyViT, Conv2d_BN, PatchEmbed, MBConv, Attention, PyTorc
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>
<br>
## ::: ultralytics.models.sam.modules.tiny_encoder.Conv2d_BN
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.PatchEmbed
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.MBConv
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.PatchMerging
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.ConvLayer
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.Mlp
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.Attention
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.TinyViTBlock
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.BasicLayer
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.LayerNorm2d
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.TinyViT

6
docs/en/reference/models/sam/modules/transformer.md
Unescape View File

@ -9,15 +9,15 @@ keywords: Ultralytics, TwoWayTransformer, module, deep learning, transformer, ob
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>
<br>
## ::: ultralytics.models.sam.modules.transformer.TwoWayTransformer
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.transformer.TwoWayAttentionBlock
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.transformer.Attention

2
docs/en/reference/models/sam/predict.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, SAM, Segment Anything Model, image segmentation, real-tim
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>
<br>
## ::: ultralytics.models.sam.predict.Predictor

4
docs/en/reference/models/utils/loss.md
Unescape View File

@ -9,11 +9,11 @@ keywords: ultralytics, YOLO, DETR, RT-DETR, loss functions, object detection, de
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>
<br>
## ::: ultralytics.models.utils.loss.DETRLoss
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.utils.loss.RTDETRDetectionLoss

4
docs/en/reference/models/utils/ops.md
Unescape View File

@ -9,11 +9,11 @@ keywords: Ultralytics, models, utils, operations, HungarianMatcher, get_cdn_grou
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>
<br>
## ::: ultralytics.models.utils.ops.HungarianMatcher
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.utils.ops.get_cdn_group

2
docs/en/reference/models/yolo/classify/predict.md
Unescape View File

@ -9,7 +9,7 @@ keywords: YOLO, ClassificationPredictor, Ultralytics, model prediction, preproce
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>
<br>
## ::: ultralytics.models.yolo.classify.predict.ClassificationPredictor

2
docs/en/reference/models/yolo/classify/train.md
Unescape View File

@ -9,7 +9,7 @@ keywords: YOLO, Ultralytics, classification, training, machine learning, deep le
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>
<br>
## ::: ultralytics.models.yolo.classify.train.ClassificationTrainer

2
docs/en/reference/models/yolo/classify/val.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, YOLO, classification, validation, ClassifyMetrics, Confus
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>
<br>
## ::: ultralytics.models.yolo.classify.val.ClassificationValidator

2
docs/en/reference/models/yolo/detect/predict.md
Unescape View File

@ -9,7 +9,7 @@ keywords: YOLO, Ultralytics, DetectionPredictor, object detection, Python, machi
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>
<br>
## ::: ultralytics.models.yolo.detect.predict.DetectionPredictor

2
docs/en/reference/models/yolo/detect/train.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, YOLO, DetectionTrainer, training, object detection, machi
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>
<br>
## ::: ultralytics.models.yolo.detect.train.DetectionTrainer

2
docs/en/reference/models/yolo/detect/val.md
Unescape View File

@ -9,7 +9,7 @@ keywords: YOLO validation, detection validation, YOLO metrics, Ultralytics, obje
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>
<br>
## ::: ultralytics.models.yolo.detect.val.DetectionValidator

4
docs/en/reference/models/yolo/model.md
Unescape View File

@ -9,11 +9,11 @@ keywords: YOLO, object detection, Ultralytics, YOLO model, machine learning, Pyt
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>
<br>
## ::: ultralytics.models.yolo.model.YOLO
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.yolo.model.YOLOWorld

2
docs/en/reference/models/yolo/obb/predict.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, YOLO, OBBPredictor, oriented bounding box, object detecti
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>
<br>
## ::: ultralytics.models.yolo.obb.predict.OBBPredictor

2
docs/en/reference/models/yolo/obb/train.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, YOLO, OBB Trainer, Oriented Bounding Box, Machine Learnin
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>
<br>
## ::: ultralytics.models.yolo.obb.train.OBBTrainer

2
docs/en/reference/models/yolo/obb/val.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, YOLO, OBBValidator, Oriented Bounding Boxes, DetectionVal
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>
<br>
## ::: ultralytics.models.yolo.obb.val.OBBValidator

2
docs/en/reference/models/yolo/pose/predict.md
Unescape View File

@ -9,7 +9,7 @@ keywords: YOLO, Pose Prediction, Ultralytics, PosePredictor, YOLOv8, Machine Lea
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>
<br>
## ::: ultralytics.models.yolo.pose.predict.PosePredictor

2
docs/en/reference/models/yolo/pose/train.md
Unescape View File

@ -9,7 +9,7 @@ keywords: PoseTrainer, YOLO, Ultralytics, pose models, training, model configura
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>
<br>
## ::: ultralytics.models.yolo.pose.train.PoseTrainer

2
docs/en/reference/models/yolo/pose/val.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, YOLO, PoseValidator, pose validation, machine learning, o
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>
<br>
## ::: ultralytics.models.yolo.pose.val.PoseValidator

2
docs/en/reference/models/yolo/segment/predict.md
Unescape View File

@ -9,7 +9,7 @@ keywords: YOLO, SegmentationPredictor, machine learning, computer vision, object
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>
<br>
## ::: ultralytics.models.yolo.segment.predict.SegmentationPredictor

2
docs/en/reference/models/yolo/segment/train.md
Unescape View File

@ -9,7 +9,7 @@ keywords: YOLO, segmentation, train, Ultralytics, SegmentationTrainer, Python, m
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>
<br>
## ::: ultralytics.models.yolo.segment.train.SegmentationTrainer

2
docs/en/reference/models/yolo/segment/val.md
Unescape View File

@ -9,7 +9,7 @@ keywords: YOLO, segmentation, validator, Ultralytics, model validation, machine
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>
<br>
## ::: ultralytics.models.yolo.segment.val.SegmentationValidator

4
docs/en/reference/models/yolo/world/train.md
Unescape View File

@ -9,11 +9,11 @@ keywords: Ultralytics, YOLO, World Model, training, deep learning, computer visi
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/world/train.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/world/train.py). 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/world/train.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.models.yolo.world.train.WorldTrainer
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.yolo.world.train.on_pretrain_routine_end

2
docs/en/reference/models/yolo/world/train_world.md
Unescape View File

@ -9,7 +9,7 @@ keywords: YOLO, WorldTrainer, open-set datasets, training, evaluation, build dat
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/world/train_world.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/world/train_world.py). 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/world/train_world.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.models.yolo.world.train_world.WorldTrainerFromScratch

6
docs/en/reference/nn/autobackend.md
Unescape View File

@ -9,15 +9,15 @@ keywords: Ultralytics, AutoBackend, check_class_names, YOLO, YOLO models, optimi
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>
<br>
## ::: ultralytics.nn.autobackend.AutoBackend
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.autobackend.check_class_names
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.autobackend.default_class_names

78
docs/en/reference/nn/modules/block.md
Unescape View File

@ -9,159 +9,159 @@ keywords: Ultralytics, YOLO, neural networks, block modules, DFL, Proto, HGStem,
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>
<br>
## ::: ultralytics.nn.modules.block.DFL
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.Proto
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.HGStem
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.HGBlock
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.SPP
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.SPPF
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C1
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C2
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C2f
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C3
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C3x
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.RepC3
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C3TR
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C3Ghost
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.GhostBottleneck
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.Bottleneck
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.BottleneckCSP
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.ResNetBlock
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.ResNetLayer
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.MaxSigmoidAttnBlock
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C2fAttn
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.ImagePoolingAttn
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.ContrastiveHead
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.BNContrastiveHead
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.RepBottleneck
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.RepCSP
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.RepNCSPELAN4
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.ELAN1
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.AConv
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.ADown
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.SPPELAN
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.CBLinear
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.CBFuse
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.RepVGGDW
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.CIB
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C2fCIB
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.Attention
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.PSA
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.SCDown

28
docs/en/reference/nn/modules/conv.md
Unescape View File

@ -9,59 +9,59 @@ keywords: Ultralytics, convolution modules, Conv, LightConv, GhostConv, YOLO, de
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>
<br>
## ::: ultralytics.nn.modules.conv.Conv
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.Conv2
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.LightConv
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.DWConv
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.DWConvTranspose2d
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.ConvTranspose
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.Focus
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.GhostConv
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.RepConv
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.ChannelAttention
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.SpatialAttention
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.CBAM
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.Concat
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.autopad

16
docs/en/reference/nn/modules/head.md
Unescape View File

@ -9,35 +9,35 @@ keywords: Ultralytics, YOLO, Detection, Pose, RTDETRDecoder, nn modules, guides
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>
<br>
## ::: ultralytics.nn.modules.head.Detect
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.Segment
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.OBB
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.Pose
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.Classify
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.WorldDetect
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.RTDETRDecoder
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.v10Detect

20
docs/en/reference/nn/modules/transformer.md
Unescape View File

@ -9,43 +9,43 @@ keywords: Ultralytics, Ultralytics documentation, TransformerEncoderLayer, Trans
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>
<br>
## ::: ultralytics.nn.modules.transformer.TransformerEncoderLayer
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.AIFI
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.TransformerLayer
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.TransformerBlock
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.MLPBlock
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.MLP
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.LayerNorm2d
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.MSDeformAttn
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.DeformableTransformerDecoderLayer
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.DeformableTransformerDecoder

10
docs/en/reference/nn/modules/utils.md
Unescape View File

@ -9,23 +9,23 @@ keywords: Ultralytics, PyTorch, utils, initialization, inverse sigmoid, multisca
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>
<br>
## ::: ultralytics.nn.modules.utils._get_clones
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.utils.bias_init_with_prob
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.utils.linear_init
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.utils.inverse_sigmoid
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.utils.multi_scale_deformable_attn_pytorch

34
docs/en/reference/nn/tasks.md
Unescape View File

@ -9,71 +9,71 @@ keywords: Ultralytics, YOLO, nn tasks, DetectionModel, PoseModel, RTDETRDetectio
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>
<br>
## ::: ultralytics.nn.tasks.BaseModel
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.DetectionModel
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.OBBModel
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.SegmentationModel
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.PoseModel
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.ClassificationModel
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.RTDETRDetectionModel
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.WorldModel
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.Ensemble
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.temporary_modules
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.torch_safe_load
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.attempt_load_weights
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.attempt_load_one_weight
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.parse_model
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.yaml_model_load
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.guess_model_scale
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.guess_model_task

2
docs/en/reference/solutions/ai_gym.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, AI Gym, YOLO, pose detection, gym step counting, real-tim
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>
<br>
## ::: ultralytics.solutions.ai_gym.AIGym

2
docs/en/reference/solutions/analytics.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, Analytics, Python, visual analytics, line chart, bar char
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/analytics.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/analytics.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/analytics.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.solutions.analytics.Analytics

2
docs/en/reference/solutions/distance_calculation.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, distance calculation, object tracking, real-time video, c
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>
<br>
## ::: ultralytics.solutions.distance_calculation.DistanceCalculation

2
docs/en/reference/solutions/heatmap.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, Heatmap, Python, Real-time Video, Object Tracking, cv2, S
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>
<br>
## ::: ultralytics.solutions.heatmap.Heatmap

2
docs/en/reference/solutions/object_counter.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, Object Counter, Real-time Tracking, Video Stream, Python,
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>
<br>
## ::: ultralytics.solutions.object_counter.ObjectCounter

4
docs/en/reference/solutions/parking_management.md
Unescape View File

@ -9,11 +9,11 @@ keywords: Ultralytics, YOLO, parking management, computer vision, parking monito
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/parking_management.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/parking_management.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/parking_management.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.solutions.parking_management.ParkingPtsSelection
<br><br>
<br><br><hr><br>
## ::: ultralytics.solutions.parking_management.ParkingManagement

2
docs/en/reference/solutions/queue_management.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, queue management, object tracking, real-time video, Pytho
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/queue_management.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/queue_management.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/queue_management.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.solutions.queue_management.QueueManager

2
docs/en/reference/solutions/speed_estimation.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, speed estimation, YOLO, real-time tracking, object tracki
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>
<br>
## ::: ultralytics.solutions.speed_estimation.SpeedEstimator

2
docs/en/reference/solutions/streamlit_inference.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, YOLOv8, live inference, real-time object detection, Strea
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/streamlit_inference.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/streamlit_inference.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/streamlit_inference.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.solutions.streamlit_inference.inference

4
docs/en/reference/trackers/basetrack.md
Unescape View File

@ -9,11 +9,11 @@ keywords: Ultralytics, YOLO, object tracking, BaseTrack, TrackState, tracking me
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>
<br>
## ::: ultralytics.trackers.basetrack.TrackState
<br><br>
<br><br><hr><br>
## ::: ultralytics.trackers.basetrack.BaseTrack

4
docs/en/reference/trackers/bot_sort.md
Unescape View File

@ -9,11 +9,11 @@ keywords: Ultralytics, Bot SORT, BOTrack, BOTSORT, YOLOv8, object tracking, Kalm
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>
<br>
## ::: ultralytics.trackers.bot_sort.BOTrack
<br><br>
<br><br><hr><br>
## ::: ultralytics.trackers.bot_sort.BOTSORT

4
docs/en/reference/trackers/byte_tracker.md
Unescape View File

@ -9,11 +9,11 @@ keywords: Ultralytics, BYTETracker, object tracking, Kalman filter, YOLOv8, docu
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>
<br>
## ::: ultralytics.trackers.byte_tracker.STrack
<br><br>
<br><br><hr><br>
## ::: ultralytics.trackers.byte_tracker.BYTETracker

6
docs/en/reference/trackers/track.md
Unescape View File

@ -9,15 +9,15 @@ keywords: Ultralytics, YOLO, object tracking, track.py, on_predict_start, on_pre
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>
<br>
## ::: ultralytics.trackers.track.on_predict_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.trackers.track.on_predict_postprocess_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.trackers.track.register_tracker

2
docs/en/reference/trackers/utils/gmc.md
Unescape View File

@ -9,7 +9,7 @@ keywords: GMC, Generalized Motion Compensation, Ultralytics, tracking, object de
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>
<br>
## ::: ultralytics.trackers.utils.gmc.GMC

4
docs/en/reference/trackers/utils/kalman_filter.md
Unescape View File

@ -9,11 +9,11 @@ keywords: Kalman Filter, Object Tracking, Python, Ultralytics, YOLO, Bounding Bo
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>
<br>
## ::: ultralytics.trackers.utils.kalman_filter.KalmanFilterXYAH
<br><br>
<br><br><hr><br>
## ::: ultralytics.trackers.utils.kalman_filter.KalmanFilterXYWH

8
docs/en/reference/trackers/utils/matching.md
Unescape View File

@ -9,19 +9,19 @@ keywords: Ultralytics, matching utils, linear assignment, IoU distance, embeddin
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>
<br>
## ::: ultralytics.trackers.utils.matching.linear_assignment
<br><br>
<br><br><hr><br>
## ::: ultralytics.trackers.utils.matching.iou_distance
<br><br>
<br><br><hr><br>
## ::: ultralytics.trackers.utils.matching.embedding_distance
<br><br>
<br><br><hr><br>
## ::: ultralytics.trackers.utils.matching.fuse_score

80
docs/en/reference/utils/__init__.md
Unescape View File

@ -9,163 +9,163 @@ keywords: Ultralytics, utils, TQDM, Python, ML, Machine Learning utilities, YOLO
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>
<br>
## ::: ultralytics.utils.TQDM
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.SimpleClass
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.IterableSimpleNamespace
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ThreadingLocked
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.TryExcept
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.Retry
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.SettingsManager
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.plt_settings
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.set_logging
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.emojis
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.yaml_save
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.yaml_load
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.yaml_print
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.read_device_model
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_ubuntu
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_colab
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_kaggle
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_jupyter
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_docker
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_raspberrypi
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_jetson
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_online
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_pip_package
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_dir_writeable
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_pytest_running
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_github_action_running
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.get_git_dir
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_git_dir
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.get_git_origin_url
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.get_git_branch
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.get_default_args
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.get_ubuntu_version
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.get_user_config_dir
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.colorstr
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.remove_colorstr
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.threaded
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.set_sentry
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.deprecation_warn
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.clean_url
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.url2file

4
docs/en/reference/utils/autobatch.md
Unescape View File

@ -9,11 +9,11 @@ keywords: YOLO batch size, CUDA memory, PyTorch autobatch, Ultralytics, machine
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>
<br>
## ::: ultralytics.utils.autobatch.check_train_batch_size
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.autobatch.autobatch

6
docs/en/reference/utils/benchmarks.md
Unescape View File

@ -9,15 +9,15 @@ keywords: YOLO, model benchmarking, ONNX, TensorRT, PyTorch, TensorFlow, CoreML,
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>
<br>
## ::: ultralytics.utils.benchmarks.RF100Benchmark
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.benchmarks.ProfileModels
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.benchmarks.benchmark

54
docs/en/reference/utils/callbacks/base.md
Unescape View File

@ -9,111 +9,111 @@ keywords: Ultralytics, base callbacks, training, validation, prediction, model e
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>
<br>
## ::: ultralytics.utils.callbacks.base.on_pretrain_routine_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_pretrain_routine_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_train_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_train_epoch_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_train_batch_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.optimizer_step
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_before_zero_grad
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_train_batch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_train_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_fit_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_model_save
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_train_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_params_update
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.teardown
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_val_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_val_batch_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_val_batch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_val_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_predict_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_predict_batch_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_predict_batch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_predict_postprocess_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_predict_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_export_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_export_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.get_default_callbacks
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.add_integration_callbacks

14
docs/en/reference/utils/callbacks/clearml.md
Unescape View File

@ -9,31 +9,31 @@ keywords: Ultralytics, YOLO, ClearML, integration, callbacks, pretraining, train
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>
<br>
## ::: ultralytics.utils.callbacks.clearml._log_debug_samples
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.clearml._log_plot
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.clearml.on_pretrain_routine_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.clearml.on_train_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.clearml.on_fit_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.clearml.on_val_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.clearml.on_train_end

48
docs/en/reference/utils/callbacks/comet.md
Unescape View File

@ -9,99 +9,99 @@ keywords: Ultralytics, YOLO, Comet, callbacks, logging, machine learning, monito
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>
<br>
## ::: ultralytics.utils.callbacks.comet._get_comet_mode
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._get_comet_model_name
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._get_eval_batch_logging_interval
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._get_max_image_predictions_to_log
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._scale_confidence_score
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._should_log_confusion_matrix
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._should_log_image_predictions
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._get_experiment_type
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._create_experiment
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._fetch_trainer_metadata
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._scale_bounding_box_to_original_image_shape
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._format_ground_truth_annotations_for_detection
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._format_prediction_annotations_for_detection
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._fetch_annotations
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._create_prediction_metadata_map
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._log_confusion_matrix
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._log_images
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._log_image_predictions
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._log_plots
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._log_model
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet.on_pretrain_routine_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet.on_train_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet.on_fit_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet.on_train_end

18
docs/en/reference/utils/callbacks/dvc.md
Unescape View File

@ -9,39 +9,39 @@ keywords: Ultralytics, DVC, DVCLive, machine learning, logging, training, callba
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>
<br>
## ::: ultralytics.utils.callbacks.dvc._log_images
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc._log_plots
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc._log_confusion_matrix
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc.on_train_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc.on_train_epoch_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc.on_fit_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc.on_train_end

18
docs/en/reference/utils/callbacks/hub.md
Unescape View File

@ -9,39 +9,39 @@ keywords: Ultralytics, callbacks, pretrain, model save, train start, train end,
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>
<br>
## ::: ultralytics.utils.callbacks.hub.on_pretrain_routine_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_pretrain_routine_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_fit_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_model_save
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_train_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_train_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_val_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_predict_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_export_start

10
docs/en/reference/utils/callbacks/mlflow.md
Unescape View File

@ -9,23 +9,23 @@ keywords: MLflow, Ultralytics YOLO, logging, metrics, parameters, model artifact
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>
<br>
## ::: ultralytics.utils.callbacks.mlflow.sanitize_dict
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.mlflow.on_pretrain_routine_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.mlflow.on_train_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.mlflow.on_fit_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.mlflow.on_train_end

16
docs/en/reference/utils/callbacks/neptune.md
Unescape View File

@ -9,35 +9,35 @@ keywords: Ultralytics, NeptuneAI, YOLO, experiment logging, machine learning, AI
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>
<br>
## ::: ultralytics.utils.callbacks.neptune._log_scalars
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune._log_images
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune._log_plot
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune.on_pretrain_routine_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune.on_train_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune.on_fit_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune.on_val_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune.on_train_end

2
docs/en/reference/utils/callbacks/raytune.md
Unescape View File

@ -9,7 +9,7 @@ keywords: Ultralytics, Ray Tune, hyperparameter tuning, YOLO, machine learning,
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>
<br>
## ::: ultralytics.utils.callbacks.raytune.on_fit_epoch_end

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

Write Preview
Loading…
Cancel
Save