ultralytics 8.0.136
refactor and simplify package (#3748)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>
This commit is contained in:
44
docs/reference/cfg/__init__.md
Normal file
44
docs/reference/cfg/__init__.md
Normal file
@ -0,0 +1,44 @@
|
||||
## cfg2dict
|
||||
---
|
||||
### ::: ultralytics.cfg.cfg2dict
|
||||
<br><br>
|
||||
|
||||
## get_cfg
|
||||
---
|
||||
### ::: ultralytics.cfg.get_cfg
|
||||
<br><br>
|
||||
|
||||
## _handle_deprecation
|
||||
---
|
||||
### ::: ultralytics.cfg._handle_deprecation
|
||||
<br><br>
|
||||
|
||||
## check_cfg_mismatch
|
||||
---
|
||||
### ::: ultralytics.cfg.check_cfg_mismatch
|
||||
<br><br>
|
||||
|
||||
## merge_equals_args
|
||||
---
|
||||
### ::: ultralytics.cfg.merge_equals_args
|
||||
<br><br>
|
||||
|
||||
## handle_yolo_hub
|
||||
---
|
||||
### ::: ultralytics.cfg.handle_yolo_hub
|
||||
<br><br>
|
||||
|
||||
## handle_yolo_settings
|
||||
---
|
||||
### ::: ultralytics.cfg.handle_yolo_settings
|
||||
<br><br>
|
||||
|
||||
## entrypoint
|
||||
---
|
||||
### ::: ultralytics.cfg.entrypoint
|
||||
<br><br>
|
||||
|
||||
## copy_default_cfg
|
||||
---
|
||||
### ::: ultralytics.cfg.copy_default_cfg
|
||||
<br><br>
|
4
docs/reference/data/annotator.md
Normal file
4
docs/reference/data/annotator.md
Normal file
@ -0,0 +1,4 @@
|
||||
## auto_annotate
|
||||
---
|
||||
### ::: ultralytics.data.annotator.auto_annotate
|
||||
<br><br>
|
94
docs/reference/data/augment.md
Normal file
94
docs/reference/data/augment.md
Normal file
@ -0,0 +1,94 @@
|
||||
## BaseTransform
|
||||
---
|
||||
### ::: ultralytics.data.augment.BaseTransform
|
||||
<br><br>
|
||||
|
||||
## Compose
|
||||
---
|
||||
### ::: ultralytics.data.augment.Compose
|
||||
<br><br>
|
||||
|
||||
## BaseMixTransform
|
||||
---
|
||||
### ::: ultralytics.data.augment.BaseMixTransform
|
||||
<br><br>
|
||||
|
||||
## Mosaic
|
||||
---
|
||||
### ::: ultralytics.data.augment.Mosaic
|
||||
<br><br>
|
||||
|
||||
## MixUp
|
||||
---
|
||||
### ::: ultralytics.data.augment.MixUp
|
||||
<br><br>
|
||||
|
||||
## RandomPerspective
|
||||
---
|
||||
### ::: ultralytics.data.augment.RandomPerspective
|
||||
<br><br>
|
||||
|
||||
## RandomHSV
|
||||
---
|
||||
### ::: ultralytics.data.augment.RandomHSV
|
||||
<br><br>
|
||||
|
||||
## RandomFlip
|
||||
---
|
||||
### ::: ultralytics.data.augment.RandomFlip
|
||||
<br><br>
|
||||
|
||||
## LetterBox
|
||||
---
|
||||
### ::: ultralytics.data.augment.LetterBox
|
||||
<br><br>
|
||||
|
||||
## CopyPaste
|
||||
---
|
||||
### ::: ultralytics.data.augment.CopyPaste
|
||||
<br><br>
|
||||
|
||||
## Albumentations
|
||||
---
|
||||
### ::: ultralytics.data.augment.Albumentations
|
||||
<br><br>
|
||||
|
||||
## Format
|
||||
---
|
||||
### ::: ultralytics.data.augment.Format
|
||||
<br><br>
|
||||
|
||||
## ClassifyLetterBox
|
||||
---
|
||||
### ::: ultralytics.data.augment.ClassifyLetterBox
|
||||
<br><br>
|
||||
|
||||
## CenterCrop
|
||||
---
|
||||
### ::: ultralytics.data.augment.CenterCrop
|
||||
<br><br>
|
||||
|
||||
## ToTensor
|
||||
---
|
||||
### ::: ultralytics.data.augment.ToTensor
|
||||
<br><br>
|
||||
|
||||
## v8_transforms
|
||||
---
|
||||
### ::: ultralytics.data.augment.v8_transforms
|
||||
<br><br>
|
||||
|
||||
## classify_transforms
|
||||
---
|
||||
### ::: ultralytics.data.augment.classify_transforms
|
||||
<br><br>
|
||||
|
||||
## hsv2colorjitter
|
||||
---
|
||||
### ::: ultralytics.data.augment.hsv2colorjitter
|
||||
<br><br>
|
||||
|
||||
## classify_albumentations
|
||||
---
|
||||
### ::: ultralytics.data.augment.classify_albumentations
|
||||
<br><br>
|
4
docs/reference/data/base.md
Normal file
4
docs/reference/data/base.md
Normal file
@ -0,0 +1,4 @@
|
||||
## BaseDataset
|
||||
---
|
||||
### ::: ultralytics.data.base.BaseDataset
|
||||
<br><br>
|
34
docs/reference/data/build.md
Normal file
34
docs/reference/data/build.md
Normal file
@ -0,0 +1,34 @@
|
||||
## InfiniteDataLoader
|
||||
---
|
||||
### ::: ultralytics.data.build.InfiniteDataLoader
|
||||
<br><br>
|
||||
|
||||
## _RepeatSampler
|
||||
---
|
||||
### ::: ultralytics.data.build._RepeatSampler
|
||||
<br><br>
|
||||
|
||||
## seed_worker
|
||||
---
|
||||
### ::: ultralytics.data.build.seed_worker
|
||||
<br><br>
|
||||
|
||||
## build_yolo_dataset
|
||||
---
|
||||
### ::: ultralytics.data.build.build_yolo_dataset
|
||||
<br><br>
|
||||
|
||||
## build_dataloader
|
||||
---
|
||||
### ::: ultralytics.data.build.build_dataloader
|
||||
<br><br>
|
||||
|
||||
## check_source
|
||||
---
|
||||
### ::: ultralytics.data.build.check_source
|
||||
<br><br>
|
||||
|
||||
## load_inference_source
|
||||
---
|
||||
### ::: ultralytics.data.build.load_inference_source
|
||||
<br><br>
|
29
docs/reference/data/converter.md
Normal file
29
docs/reference/data/converter.md
Normal file
@ -0,0 +1,29 @@
|
||||
## coco91_to_coco80_class
|
||||
---
|
||||
### ::: ultralytics.data.converter.coco91_to_coco80_class
|
||||
<br><br>
|
||||
|
||||
## convert_coco
|
||||
---
|
||||
### ::: ultralytics.data.converter.convert_coco
|
||||
<br><br>
|
||||
|
||||
## rle2polygon
|
||||
---
|
||||
### ::: ultralytics.data.converter.rle2polygon
|
||||
<br><br>
|
||||
|
||||
## min_index
|
||||
---
|
||||
### ::: ultralytics.data.converter.min_index
|
||||
<br><br>
|
||||
|
||||
## merge_multi_segment
|
||||
---
|
||||
### ::: ultralytics.data.converter.merge_multi_segment
|
||||
<br><br>
|
||||
|
||||
## delete_dsstore
|
||||
---
|
||||
### ::: ultralytics.data.converter.delete_dsstore
|
||||
<br><br>
|
14
docs/reference/data/dataset.md
Normal file
14
docs/reference/data/dataset.md
Normal file
@ -0,0 +1,14 @@
|
||||
## YOLODataset
|
||||
---
|
||||
### ::: ultralytics.data.dataset.YOLODataset
|
||||
<br><br>
|
||||
|
||||
## ClassificationDataset
|
||||
---
|
||||
### ::: ultralytics.data.dataset.ClassificationDataset
|
||||
<br><br>
|
||||
|
||||
## SemanticDataset
|
||||
---
|
||||
### ::: ultralytics.data.dataset.SemanticDataset
|
||||
<br><br>
|
39
docs/reference/data/loaders.md
Normal file
39
docs/reference/data/loaders.md
Normal file
@ -0,0 +1,39 @@
|
||||
## SourceTypes
|
||||
---
|
||||
### ::: ultralytics.data.loaders.SourceTypes
|
||||
<br><br>
|
||||
|
||||
## LoadStreams
|
||||
---
|
||||
### ::: ultralytics.data.loaders.LoadStreams
|
||||
<br><br>
|
||||
|
||||
## LoadScreenshots
|
||||
---
|
||||
### ::: ultralytics.data.loaders.LoadScreenshots
|
||||
<br><br>
|
||||
|
||||
## LoadImages
|
||||
---
|
||||
### ::: ultralytics.data.loaders.LoadImages
|
||||
<br><br>
|
||||
|
||||
## LoadPilAndNumpy
|
||||
---
|
||||
### ::: ultralytics.data.loaders.LoadPilAndNumpy
|
||||
<br><br>
|
||||
|
||||
## LoadTensor
|
||||
---
|
||||
### ::: ultralytics.data.loaders.LoadTensor
|
||||
<br><br>
|
||||
|
||||
## autocast_list
|
||||
---
|
||||
### ::: ultralytics.data.loaders.autocast_list
|
||||
<br><br>
|
||||
|
||||
## get_best_youtube_url
|
||||
---
|
||||
### ::: ultralytics.data.loaders.get_best_youtube_url
|
||||
<br><br>
|
69
docs/reference/data/utils.md
Normal file
69
docs/reference/data/utils.md
Normal file
@ -0,0 +1,69 @@
|
||||
## HUBDatasetStats
|
||||
---
|
||||
### ::: ultralytics.data.utils.HUBDatasetStats
|
||||
<br><br>
|
||||
|
||||
## img2label_paths
|
||||
---
|
||||
### ::: ultralytics.data.utils.img2label_paths
|
||||
<br><br>
|
||||
|
||||
## get_hash
|
||||
---
|
||||
### ::: ultralytics.data.utils.get_hash
|
||||
<br><br>
|
||||
|
||||
## exif_size
|
||||
---
|
||||
### ::: ultralytics.data.utils.exif_size
|
||||
<br><br>
|
||||
|
||||
## verify_image_label
|
||||
---
|
||||
### ::: ultralytics.data.utils.verify_image_label
|
||||
<br><br>
|
||||
|
||||
## polygon2mask
|
||||
---
|
||||
### ::: ultralytics.data.utils.polygon2mask
|
||||
<br><br>
|
||||
|
||||
## polygons2masks
|
||||
---
|
||||
### ::: ultralytics.data.utils.polygons2masks
|
||||
<br><br>
|
||||
|
||||
## polygons2masks_overlap
|
||||
---
|
||||
### ::: ultralytics.data.utils.polygons2masks_overlap
|
||||
<br><br>
|
||||
|
||||
## check_det_dataset
|
||||
---
|
||||
### ::: ultralytics.data.utils.check_det_dataset
|
||||
<br><br>
|
||||
|
||||
## check_cls_dataset
|
||||
---
|
||||
### ::: ultralytics.data.utils.check_cls_dataset
|
||||
<br><br>
|
||||
|
||||
## compress_one_image
|
||||
---
|
||||
### ::: ultralytics.data.utils.compress_one_image
|
||||
<br><br>
|
||||
|
||||
## delete_dsstore
|
||||
---
|
||||
### ::: ultralytics.data.utils.delete_dsstore
|
||||
<br><br>
|
||||
|
||||
## zip_directory
|
||||
---
|
||||
### ::: ultralytics.data.utils.zip_directory
|
||||
<br><br>
|
||||
|
||||
## autosplit
|
||||
---
|
||||
### ::: ultralytics.data.utils.autosplit
|
||||
<br><br>
|
29
docs/reference/engine/exporter.md
Normal file
29
docs/reference/engine/exporter.md
Normal file
@ -0,0 +1,29 @@
|
||||
## Exporter
|
||||
---
|
||||
### ::: ultralytics.engine.exporter.Exporter
|
||||
<br><br>
|
||||
|
||||
## iOSDetectModel
|
||||
---
|
||||
### ::: ultralytics.engine.exporter.iOSDetectModel
|
||||
<br><br>
|
||||
|
||||
## export_formats
|
||||
---
|
||||
### ::: ultralytics.engine.exporter.export_formats
|
||||
<br><br>
|
||||
|
||||
## gd_outputs
|
||||
---
|
||||
### ::: ultralytics.engine.exporter.gd_outputs
|
||||
<br><br>
|
||||
|
||||
## try_export
|
||||
---
|
||||
### ::: ultralytics.engine.exporter.try_export
|
||||
<br><br>
|
||||
|
||||
## export
|
||||
---
|
||||
### ::: ultralytics.engine.exporter.export
|
||||
<br><br>
|
4
docs/reference/engine/model.md
Normal file
4
docs/reference/engine/model.md
Normal file
@ -0,0 +1,4 @@
|
||||
## YOLO
|
||||
---
|
||||
### ::: ultralytics.engine.model.YOLO
|
||||
<br><br>
|
4
docs/reference/engine/predictor.md
Normal file
4
docs/reference/engine/predictor.md
Normal file
@ -0,0 +1,4 @@
|
||||
## BasePredictor
|
||||
---
|
||||
### ::: ultralytics.engine.predictor.BasePredictor
|
||||
<br><br>
|
29
docs/reference/engine/results.md
Normal file
29
docs/reference/engine/results.md
Normal file
@ -0,0 +1,29 @@
|
||||
## BaseTensor
|
||||
---
|
||||
### ::: ultralytics.engine.results.BaseTensor
|
||||
<br><br>
|
||||
|
||||
## Results
|
||||
---
|
||||
### ::: ultralytics.engine.results.Results
|
||||
<br><br>
|
||||
|
||||
## Boxes
|
||||
---
|
||||
### ::: ultralytics.engine.results.Boxes
|
||||
<br><br>
|
||||
|
||||
## Masks
|
||||
---
|
||||
### ::: ultralytics.engine.results.Masks
|
||||
<br><br>
|
||||
|
||||
## Keypoints
|
||||
---
|
||||
### ::: ultralytics.engine.results.Keypoints
|
||||
<br><br>
|
||||
|
||||
## Probs
|
||||
---
|
||||
### ::: ultralytics.engine.results.Probs
|
||||
<br><br>
|
4
docs/reference/engine/trainer.md
Normal file
4
docs/reference/engine/trainer.md
Normal file
@ -0,0 +1,4 @@
|
||||
## BaseTrainer
|
||||
---
|
||||
### ::: ultralytics.engine.trainer.BaseTrainer
|
||||
<br><br>
|
4
docs/reference/engine/validator.md
Normal file
4
docs/reference/engine/validator.md
Normal file
@ -0,0 +1,4 @@
|
||||
## BaseValidator
|
||||
---
|
||||
### ::: ultralytics.engine.validator.BaseValidator
|
||||
<br><br>
|
@ -1,8 +1,3 @@
|
||||
---
|
||||
description: Access Ultralytics HUB, manage API keys, train models, and export in various formats with ease using the HUB API.
|
||||
keywords: Ultralytics, YOLO, Docs HUB, API, login, logout, reset model, export model, check dataset, HUBDatasetStats, YOLO training, YOLO model
|
||||
---
|
||||
|
||||
## login
|
||||
---
|
||||
### ::: ultralytics.hub.login
|
||||
|
@ -1,8 +1,3 @@
|
||||
---
|
||||
description: Learn how to use Ultralytics hub authentication in your projects with examples and guidelines from the Auth page on Ultralytics Docs.
|
||||
keywords: Ultralytics, ultralytics hub, api keys, authentication, collab accounts, requests, hub management, monitoring
|
||||
---
|
||||
|
||||
## Auth
|
||||
---
|
||||
### ::: ultralytics.hub.auth.Auth
|
||||
|
@ -1,8 +1,3 @@
|
||||
---
|
||||
description: Accelerate your AI development with the Ultralytics HUB Training Session. High-performance training of object detection models.
|
||||
keywords: YOLOv5, object detection, HUBTrainingSession, custom models, Ultralytics Docs
|
||||
---
|
||||
|
||||
## HUBTrainingSession
|
||||
---
|
||||
### ::: ultralytics.hub.session.HUBTrainingSession
|
||||
|
@ -1,8 +1,3 @@
|
||||
---
|
||||
description: Explore Ultralytics events, including 'request_with_credentials' and 'smart_request', to improve your project's performance and efficiency.
|
||||
keywords: Ultralytics, Hub Utils, API Documentation, Python, requests_with_progress, Events, classes, usage, examples
|
||||
---
|
||||
|
||||
## Events
|
||||
---
|
||||
### ::: ultralytics.hub.utils.Events
|
||||
|
4
docs/reference/models/fastsam/model.md
Normal file
4
docs/reference/models/fastsam/model.md
Normal file
@ -0,0 +1,4 @@
|
||||
## FastSAM
|
||||
---
|
||||
### ::: ultralytics.models.fastsam.model.FastSAM
|
||||
<br><br>
|
4
docs/reference/models/fastsam/predict.md
Normal file
4
docs/reference/models/fastsam/predict.md
Normal file
@ -0,0 +1,4 @@
|
||||
## FastSAMPredictor
|
||||
---
|
||||
### ::: ultralytics.models.fastsam.predict.FastSAMPredictor
|
||||
<br><br>
|
4
docs/reference/models/fastsam/prompt.md
Normal file
4
docs/reference/models/fastsam/prompt.md
Normal file
@ -0,0 +1,4 @@
|
||||
## FastSAMPrompt
|
||||
---
|
||||
### ::: ultralytics.models.fastsam.prompt.FastSAMPrompt
|
||||
<br><br>
|
9
docs/reference/models/fastsam/utils.md
Normal file
9
docs/reference/models/fastsam/utils.md
Normal file
@ -0,0 +1,9 @@
|
||||
## adjust_bboxes_to_image_border
|
||||
---
|
||||
### ::: ultralytics.models.fastsam.utils.adjust_bboxes_to_image_border
|
||||
<br><br>
|
||||
|
||||
## bbox_iou
|
||||
---
|
||||
### ::: ultralytics.models.fastsam.utils.bbox_iou
|
||||
<br><br>
|
4
docs/reference/models/fastsam/val.md
Normal file
4
docs/reference/models/fastsam/val.md
Normal file
@ -0,0 +1,4 @@
|
||||
## FastSAMValidator
|
||||
---
|
||||
### ::: ultralytics.models.fastsam.val.FastSAMValidator
|
||||
<br><br>
|
4
docs/reference/models/nas/model.md
Normal file
4
docs/reference/models/nas/model.md
Normal file
@ -0,0 +1,4 @@
|
||||
## NAS
|
||||
---
|
||||
### ::: ultralytics.models.nas.model.NAS
|
||||
<br><br>
|
4
docs/reference/models/nas/predict.md
Normal file
4
docs/reference/models/nas/predict.md
Normal file
@ -0,0 +1,4 @@
|
||||
## NASPredictor
|
||||
---
|
||||
### ::: ultralytics.models.nas.predict.NASPredictor
|
||||
<br><br>
|
4
docs/reference/models/nas/val.md
Normal file
4
docs/reference/models/nas/val.md
Normal file
@ -0,0 +1,4 @@
|
||||
## NASValidator
|
||||
---
|
||||
### ::: ultralytics.models.nas.val.NASValidator
|
||||
<br><br>
|
4
docs/reference/models/rtdetr/model.md
Normal file
4
docs/reference/models/rtdetr/model.md
Normal file
@ -0,0 +1,4 @@
|
||||
## RTDETR
|
||||
---
|
||||
### ::: ultralytics.models.rtdetr.model.RTDETR
|
||||
<br><br>
|
4
docs/reference/models/rtdetr/predict.md
Normal file
4
docs/reference/models/rtdetr/predict.md
Normal file
@ -0,0 +1,4 @@
|
||||
## RTDETRPredictor
|
||||
---
|
||||
### ::: ultralytics.models.rtdetr.predict.RTDETRPredictor
|
||||
<br><br>
|
9
docs/reference/models/rtdetr/train.md
Normal file
9
docs/reference/models/rtdetr/train.md
Normal file
@ -0,0 +1,9 @@
|
||||
## RTDETRTrainer
|
||||
---
|
||||
### ::: ultralytics.models.rtdetr.train.RTDETRTrainer
|
||||
<br><br>
|
||||
|
||||
## train
|
||||
---
|
||||
### ::: ultralytics.models.rtdetr.train.train
|
||||
<br><br>
|
9
docs/reference/models/rtdetr/val.md
Normal file
9
docs/reference/models/rtdetr/val.md
Normal file
@ -0,0 +1,9 @@
|
||||
## RTDETRDataset
|
||||
---
|
||||
### ::: ultralytics.models.rtdetr.val.RTDETRDataset
|
||||
<br><br>
|
||||
|
||||
## RTDETRValidator
|
||||
---
|
||||
### ::: ultralytics.models.rtdetr.val.RTDETRValidator
|
||||
<br><br>
|
84
docs/reference/models/sam/amg.md
Normal file
84
docs/reference/models/sam/amg.md
Normal file
@ -0,0 +1,84 @@
|
||||
## MaskData
|
||||
---
|
||||
### ::: ultralytics.models.sam.amg.MaskData
|
||||
<br><br>
|
||||
|
||||
## is_box_near_crop_edge
|
||||
---
|
||||
### ::: ultralytics.models.sam.amg.is_box_near_crop_edge
|
||||
<br><br>
|
||||
|
||||
## box_xyxy_to_xywh
|
||||
---
|
||||
### ::: ultralytics.models.sam.amg.box_xyxy_to_xywh
|
||||
<br><br>
|
||||
|
||||
## batch_iterator
|
||||
---
|
||||
### ::: ultralytics.models.sam.amg.batch_iterator
|
||||
<br><br>
|
||||
|
||||
## mask_to_rle_pytorch
|
||||
---
|
||||
### ::: ultralytics.models.sam.amg.mask_to_rle_pytorch
|
||||
<br><br>
|
||||
|
||||
## rle_to_mask
|
||||
---
|
||||
### ::: ultralytics.models.sam.amg.rle_to_mask
|
||||
<br><br>
|
||||
|
||||
## area_from_rle
|
||||
---
|
||||
### ::: ultralytics.models.sam.amg.area_from_rle
|
||||
<br><br>
|
||||
|
||||
## calculate_stability_score
|
||||
---
|
||||
### ::: ultralytics.models.sam.amg.calculate_stability_score
|
||||
<br><br>
|
||||
|
||||
## build_point_grid
|
||||
---
|
||||
### ::: ultralytics.models.sam.amg.build_point_grid
|
||||
<br><br>
|
||||
|
||||
## build_all_layer_point_grids
|
||||
---
|
||||
### ::: ultralytics.models.sam.amg.build_all_layer_point_grids
|
||||
<br><br>
|
||||
|
||||
## generate_crop_boxes
|
||||
---
|
||||
### ::: ultralytics.models.sam.amg.generate_crop_boxes
|
||||
<br><br>
|
||||
|
||||
## uncrop_boxes_xyxy
|
||||
---
|
||||
### ::: ultralytics.models.sam.amg.uncrop_boxes_xyxy
|
||||
<br><br>
|
||||
|
||||
## uncrop_points
|
||||
---
|
||||
### ::: ultralytics.models.sam.amg.uncrop_points
|
||||
<br><br>
|
||||
|
||||
## uncrop_masks
|
||||
---
|
||||
### ::: ultralytics.models.sam.amg.uncrop_masks
|
||||
<br><br>
|
||||
|
||||
## remove_small_regions
|
||||
---
|
||||
### ::: ultralytics.models.sam.amg.remove_small_regions
|
||||
<br><br>
|
||||
|
||||
## coco_encode_rle
|
||||
---
|
||||
### ::: ultralytics.models.sam.amg.coco_encode_rle
|
||||
<br><br>
|
||||
|
||||
## batched_mask_to_box
|
||||
---
|
||||
### ::: ultralytics.models.sam.amg.batched_mask_to_box
|
||||
<br><br>
|
29
docs/reference/models/sam/build.md
Normal file
29
docs/reference/models/sam/build.md
Normal file
@ -0,0 +1,29 @@
|
||||
## build_sam_vit_h
|
||||
---
|
||||
### ::: ultralytics.models.sam.build.build_sam_vit_h
|
||||
<br><br>
|
||||
|
||||
## build_sam_vit_l
|
||||
---
|
||||
### ::: ultralytics.models.sam.build.build_sam_vit_l
|
||||
<br><br>
|
||||
|
||||
## build_sam_vit_b
|
||||
---
|
||||
### ::: ultralytics.models.sam.build.build_sam_vit_b
|
||||
<br><br>
|
||||
|
||||
## build_mobile_sam
|
||||
---
|
||||
### ::: ultralytics.models.sam.build.build_mobile_sam
|
||||
<br><br>
|
||||
|
||||
## _build_sam
|
||||
---
|
||||
### ::: ultralytics.models.sam.build._build_sam
|
||||
<br><br>
|
||||
|
||||
## build_sam
|
||||
---
|
||||
### ::: ultralytics.models.sam.build.build_sam
|
||||
<br><br>
|
4
docs/reference/models/sam/model.md
Normal file
4
docs/reference/models/sam/model.md
Normal file
@ -0,0 +1,4 @@
|
||||
## SAM
|
||||
---
|
||||
### ::: ultralytics.models.sam.model.SAM
|
||||
<br><br>
|
9
docs/reference/models/sam/modules/decoders.md
Normal file
9
docs/reference/models/sam/modules/decoders.md
Normal file
@ -0,0 +1,9 @@
|
||||
## MaskDecoder
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.decoders.MaskDecoder
|
||||
<br><br>
|
||||
|
||||
## MLP
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.decoders.MLP
|
||||
<br><br>
|
49
docs/reference/models/sam/modules/encoders.md
Normal file
49
docs/reference/models/sam/modules/encoders.md
Normal file
@ -0,0 +1,49 @@
|
||||
## ImageEncoderViT
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.encoders.ImageEncoderViT
|
||||
<br><br>
|
||||
|
||||
## PromptEncoder
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.encoders.PromptEncoder
|
||||
<br><br>
|
||||
|
||||
## PositionEmbeddingRandom
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.encoders.PositionEmbeddingRandom
|
||||
<br><br>
|
||||
|
||||
## Block
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.encoders.Block
|
||||
<br><br>
|
||||
|
||||
## Attention
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.encoders.Attention
|
||||
<br><br>
|
||||
|
||||
## PatchEmbed
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.encoders.PatchEmbed
|
||||
<br><br>
|
||||
|
||||
## window_partition
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.encoders.window_partition
|
||||
<br><br>
|
||||
|
||||
## window_unpartition
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.encoders.window_unpartition
|
||||
<br><br>
|
||||
|
||||
## get_rel_pos
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.encoders.get_rel_pos
|
||||
<br><br>
|
||||
|
||||
## add_decomposed_rel_pos
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.encoders.add_decomposed_rel_pos
|
||||
<br><br>
|
4
docs/reference/models/sam/modules/sam.md
Normal file
4
docs/reference/models/sam/modules/sam.md
Normal file
@ -0,0 +1,4 @@
|
||||
## Sam
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.sam.Sam
|
||||
<br><br>
|
54
docs/reference/models/sam/modules/tiny_encoder.md
Normal file
54
docs/reference/models/sam/modules/tiny_encoder.md
Normal file
@ -0,0 +1,54 @@
|
||||
## Conv2d_BN
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.tiny_encoder.Conv2d_BN
|
||||
<br><br>
|
||||
|
||||
## PatchEmbed
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.tiny_encoder.PatchEmbed
|
||||
<br><br>
|
||||
|
||||
## MBConv
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.tiny_encoder.MBConv
|
||||
<br><br>
|
||||
|
||||
## PatchMerging
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.tiny_encoder.PatchMerging
|
||||
<br><br>
|
||||
|
||||
## ConvLayer
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.tiny_encoder.ConvLayer
|
||||
<br><br>
|
||||
|
||||
## Mlp
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.tiny_encoder.Mlp
|
||||
<br><br>
|
||||
|
||||
## Attention
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.tiny_encoder.Attention
|
||||
<br><br>
|
||||
|
||||
## TinyViTBlock
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.tiny_encoder.TinyViTBlock
|
||||
<br><br>
|
||||
|
||||
## BasicLayer
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.tiny_encoder.BasicLayer
|
||||
<br><br>
|
||||
|
||||
## LayerNorm2d
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.tiny_encoder.LayerNorm2d
|
||||
<br><br>
|
||||
|
||||
## TinyViT
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.tiny_encoder.TinyViT
|
||||
<br><br>
|
14
docs/reference/models/sam/modules/transformer.md
Normal file
14
docs/reference/models/sam/modules/transformer.md
Normal file
@ -0,0 +1,14 @@
|
||||
## TwoWayTransformer
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.transformer.TwoWayTransformer
|
||||
<br><br>
|
||||
|
||||
## TwoWayAttentionBlock
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.transformer.TwoWayAttentionBlock
|
||||
<br><br>
|
||||
|
||||
## Attention
|
||||
---
|
||||
### ::: ultralytics.models.sam.modules.transformer.Attention
|
||||
<br><br>
|
4
docs/reference/models/sam/predict.md
Normal file
4
docs/reference/models/sam/predict.md
Normal file
@ -0,0 +1,4 @@
|
||||
## Predictor
|
||||
---
|
||||
### ::: ultralytics.models.sam.predict.Predictor
|
||||
<br><br>
|
9
docs/reference/models/utils/loss.md
Normal file
9
docs/reference/models/utils/loss.md
Normal file
@ -0,0 +1,9 @@
|
||||
## DETRLoss
|
||||
---
|
||||
### ::: ultralytics.models.utils.loss.DETRLoss
|
||||
<br><br>
|
||||
|
||||
## RTDETRDetectionLoss
|
||||
---
|
||||
### ::: ultralytics.models.utils.loss.RTDETRDetectionLoss
|
||||
<br><br>
|
14
docs/reference/models/utils/ops.md
Normal file
14
docs/reference/models/utils/ops.md
Normal file
@ -0,0 +1,14 @@
|
||||
## HungarianMatcher
|
||||
---
|
||||
### ::: ultralytics.models.utils.ops.HungarianMatcher
|
||||
<br><br>
|
||||
|
||||
## get_cdn_group
|
||||
---
|
||||
### ::: ultralytics.models.utils.ops.get_cdn_group
|
||||
<br><br>
|
||||
|
||||
## inverse_sigmoid
|
||||
---
|
||||
### ::: ultralytics.models.utils.ops.inverse_sigmoid
|
||||
<br><br>
|
9
docs/reference/models/yolo/classify/predict.md
Normal file
9
docs/reference/models/yolo/classify/predict.md
Normal file
@ -0,0 +1,9 @@
|
||||
## ClassificationPredictor
|
||||
---
|
||||
### ::: ultralytics.models.yolo.classify.predict.ClassificationPredictor
|
||||
<br><br>
|
||||
|
||||
## predict
|
||||
---
|
||||
### ::: ultralytics.models.yolo.classify.predict.predict
|
||||
<br><br>
|
9
docs/reference/models/yolo/classify/train.md
Normal file
9
docs/reference/models/yolo/classify/train.md
Normal file
@ -0,0 +1,9 @@
|
||||
## ClassificationTrainer
|
||||
---
|
||||
### ::: ultralytics.models.yolo.classify.train.ClassificationTrainer
|
||||
<br><br>
|
||||
|
||||
## train
|
||||
---
|
||||
### ::: ultralytics.models.yolo.classify.train.train
|
||||
<br><br>
|
9
docs/reference/models/yolo/classify/val.md
Normal file
9
docs/reference/models/yolo/classify/val.md
Normal file
@ -0,0 +1,9 @@
|
||||
## ClassificationValidator
|
||||
---
|
||||
### ::: ultralytics.models.yolo.classify.val.ClassificationValidator
|
||||
<br><br>
|
||||
|
||||
## val
|
||||
---
|
||||
### ::: ultralytics.models.yolo.classify.val.val
|
||||
<br><br>
|
9
docs/reference/models/yolo/detect/predict.md
Normal file
9
docs/reference/models/yolo/detect/predict.md
Normal file
@ -0,0 +1,9 @@
|
||||
## DetectionPredictor
|
||||
---
|
||||
### ::: ultralytics.models.yolo.detect.predict.DetectionPredictor
|
||||
<br><br>
|
||||
|
||||
## predict
|
||||
---
|
||||
### ::: ultralytics.models.yolo.detect.predict.predict
|
||||
<br><br>
|
9
docs/reference/models/yolo/detect/train.md
Normal file
9
docs/reference/models/yolo/detect/train.md
Normal file
@ -0,0 +1,9 @@
|
||||
## DetectionTrainer
|
||||
---
|
||||
### ::: ultralytics.models.yolo.detect.train.DetectionTrainer
|
||||
<br><br>
|
||||
|
||||
## train
|
||||
---
|
||||
### ::: ultralytics.models.yolo.detect.train.train
|
||||
<br><br>
|
9
docs/reference/models/yolo/detect/val.md
Normal file
9
docs/reference/models/yolo/detect/val.md
Normal file
@ -0,0 +1,9 @@
|
||||
## DetectionValidator
|
||||
---
|
||||
### ::: ultralytics.models.yolo.detect.val.DetectionValidator
|
||||
<br><br>
|
||||
|
||||
## val
|
||||
---
|
||||
### ::: ultralytics.models.yolo.detect.val.val
|
||||
<br><br>
|
9
docs/reference/models/yolo/pose/predict.md
Normal file
9
docs/reference/models/yolo/pose/predict.md
Normal file
@ -0,0 +1,9 @@
|
||||
## PosePredictor
|
||||
---
|
||||
### ::: ultralytics.models.yolo.pose.predict.PosePredictor
|
||||
<br><br>
|
||||
|
||||
## predict
|
||||
---
|
||||
### ::: ultralytics.models.yolo.pose.predict.predict
|
||||
<br><br>
|
9
docs/reference/models/yolo/pose/train.md
Normal file
9
docs/reference/models/yolo/pose/train.md
Normal file
@ -0,0 +1,9 @@
|
||||
## PoseTrainer
|
||||
---
|
||||
### ::: ultralytics.models.yolo.pose.train.PoseTrainer
|
||||
<br><br>
|
||||
|
||||
## train
|
||||
---
|
||||
### ::: ultralytics.models.yolo.pose.train.train
|
||||
<br><br>
|
9
docs/reference/models/yolo/pose/val.md
Normal file
9
docs/reference/models/yolo/pose/val.md
Normal file
@ -0,0 +1,9 @@
|
||||
## PoseValidator
|
||||
---
|
||||
### ::: ultralytics.models.yolo.pose.val.PoseValidator
|
||||
<br><br>
|
||||
|
||||
## val
|
||||
---
|
||||
### ::: ultralytics.models.yolo.pose.val.val
|
||||
<br><br>
|
9
docs/reference/models/yolo/segment/predict.md
Normal file
9
docs/reference/models/yolo/segment/predict.md
Normal file
@ -0,0 +1,9 @@
|
||||
## SegmentationPredictor
|
||||
---
|
||||
### ::: ultralytics.models.yolo.segment.predict.SegmentationPredictor
|
||||
<br><br>
|
||||
|
||||
## predict
|
||||
---
|
||||
### ::: ultralytics.models.yolo.segment.predict.predict
|
||||
<br><br>
|
9
docs/reference/models/yolo/segment/train.md
Normal file
9
docs/reference/models/yolo/segment/train.md
Normal file
@ -0,0 +1,9 @@
|
||||
## SegmentationTrainer
|
||||
---
|
||||
### ::: ultralytics.models.yolo.segment.train.SegmentationTrainer
|
||||
<br><br>
|
||||
|
||||
## train
|
||||
---
|
||||
### ::: ultralytics.models.yolo.segment.train.train
|
||||
<br><br>
|
9
docs/reference/models/yolo/segment/val.md
Normal file
9
docs/reference/models/yolo/segment/val.md
Normal file
@ -0,0 +1,9 @@
|
||||
## SegmentationValidator
|
||||
---
|
||||
### ::: ultralytics.models.yolo.segment.val.SegmentationValidator
|
||||
<br><br>
|
||||
|
||||
## val
|
||||
---
|
||||
### ::: ultralytics.models.yolo.segment.val.val
|
||||
<br><br>
|
@ -1,8 +1,3 @@
|
||||
---
|
||||
description: Ensure class names match filenames for easy imports. Use AutoBackend to automatically rename and refactor model files.
|
||||
keywords: AutoBackend, ultralytics, nn, autobackend, check class names, neural network
|
||||
---
|
||||
|
||||
## AutoBackend
|
||||
---
|
||||
### ::: ultralytics.nn.autobackend.AutoBackend
|
||||
|
@ -1,8 +1,3 @@
|
||||
---
|
||||
description: Explore ultralytics.nn.modules.block to build powerful YOLO object detection models. Master DFL, HGStem, SPP, CSP components and more.
|
||||
keywords: Ultralytics, NN Modules, Blocks, DFL, HGStem, SPP, C1, C2f, C3x, C3TR, GhostBottleneck, BottleneckCSP, Computer Vision
|
||||
---
|
||||
|
||||
## DFL
|
||||
---
|
||||
### ::: ultralytics.nn.modules.block.DFL
|
||||
|
@ -1,8 +1,3 @@
|
||||
---
|
||||
description: Explore convolutional neural network modules & techniques such as LightConv, DWConv, ConvTranspose, GhostConv, CBAM & autopad with Ultralytics Docs.
|
||||
keywords: Ultralytics, Convolutional Neural Network, Conv2, DWConv, ConvTranspose, GhostConv, ChannelAttention, CBAM, autopad
|
||||
---
|
||||
|
||||
## Conv
|
||||
---
|
||||
### ::: ultralytics.nn.modules.conv.Conv
|
||||
|
@ -1,8 +1,3 @@
|
||||
---
|
||||
description: 'Learn about Ultralytics YOLO modules: Segment, Classify, and RTDETRDecoder. Optimize object detection and classification in your project.'
|
||||
keywords: Ultralytics, YOLO, object detection, pose estimation, RTDETRDecoder, modules, classes, documentation
|
||||
---
|
||||
|
||||
## Detect
|
||||
---
|
||||
### ::: ultralytics.nn.modules.head.Detect
|
||||
|
@ -1,8 +1,3 @@
|
||||
---
|
||||
description: Explore the Ultralytics nn modules pages on Transformer and MLP blocks, LayerNorm2d, and Deformable Transformer Decoder Layer.
|
||||
keywords: Ultralytics, NN Modules, TransformerEncoderLayer, TransformerLayer, MLPBlock, LayerNorm2d, DeformableTransformerDecoderLayer, examples, code snippets, tutorials
|
||||
---
|
||||
|
||||
## TransformerEncoderLayer
|
||||
---
|
||||
### ::: ultralytics.nn.modules.transformer.TransformerEncoderLayer
|
||||
|
@ -1,8 +1,3 @@
|
||||
---
|
||||
description: 'Learn about Ultralytics NN modules: get_clones, linear_init_, and multi_scale_deformable_attn_pytorch. Code examples and usage tips.'
|
||||
keywords: Ultralytics, NN Utils, Docs, PyTorch, bias initialization, linear initialization, multi-scale deformable attention
|
||||
---
|
||||
|
||||
## _get_clones
|
||||
---
|
||||
### ::: ultralytics.nn.modules.utils._get_clones
|
||||
|
@ -1,8 +1,3 @@
|
||||
---
|
||||
description: Learn how to work with Ultralytics YOLO Detection, Segmentation & Classification Models, load weights and parse models in PyTorch.
|
||||
keywords: neural network, deep learning, computer vision, object detection, image segmentation, image classification, model ensemble, PyTorch
|
||||
---
|
||||
|
||||
## BaseModel
|
||||
---
|
||||
### ::: ultralytics.nn.tasks.BaseModel
|
||||
@ -38,6 +33,11 @@ keywords: neural network, deep learning, computer vision, object detection, imag
|
||||
### ::: ultralytics.nn.tasks.Ensemble
|
||||
<br><br>
|
||||
|
||||
## temporary_modules
|
||||
---
|
||||
### ::: ultralytics.nn.tasks.temporary_modules
|
||||
<br><br>
|
||||
|
||||
## torch_safe_load
|
||||
---
|
||||
### ::: ultralytics.nn.tasks.torch_safe_load
|
||||
|
@ -1,19 +0,0 @@
|
||||
---
|
||||
description: Learn how to register custom event-tracking and track predictions with Ultralytics YOLO via on_predict_start and register_tracker methods.
|
||||
keywords: Ultralytics YOLO, tracker registration, on_predict_start, object detection
|
||||
---
|
||||
|
||||
## on_predict_start
|
||||
---
|
||||
### ::: ultralytics.tracker.track.on_predict_start
|
||||
<br><br>
|
||||
|
||||
## on_predict_postprocess_end
|
||||
---
|
||||
### ::: ultralytics.tracker.track.on_predict_postprocess_end
|
||||
<br><br>
|
||||
|
||||
## register_tracker
|
||||
---
|
||||
### ::: ultralytics.tracker.track.register_tracker
|
||||
<br><br>
|
@ -1,14 +0,0 @@
|
||||
---
|
||||
description: 'TrackState: A comprehensive guide to Ultralytics tracker''s BaseTrack for monitoring model performance. Improve your tracking capabilities now!'
|
||||
keywords: object detection, object tracking, Ultralytics YOLO, TrackState, workflow improvement
|
||||
---
|
||||
|
||||
## TrackState
|
||||
---
|
||||
### ::: ultralytics.tracker.trackers.basetrack.TrackState
|
||||
<br><br>
|
||||
|
||||
## BaseTrack
|
||||
---
|
||||
### ::: ultralytics.tracker.trackers.basetrack.BaseTrack
|
||||
<br><br>
|
@ -1,14 +0,0 @@
|
||||
---
|
||||
description: '"Optimize tracking with Ultralytics BOTrack. Easily sort and track bots with BOTSORT. Streamline data collection for improved performance."'
|
||||
keywords: BOTrack, Ultralytics YOLO Docs, features, usage
|
||||
---
|
||||
|
||||
## BOTrack
|
||||
---
|
||||
### ::: ultralytics.tracker.trackers.bot_sort.BOTrack
|
||||
<br><br>
|
||||
|
||||
## BOTSORT
|
||||
---
|
||||
### ::: ultralytics.tracker.trackers.bot_sort.BOTSORT
|
||||
<br><br>
|
@ -1,14 +0,0 @@
|
||||
---
|
||||
description: Learn how to track ByteAI model sizes and tips for model optimization with STrack, a byte tracking tool from Ultralytics.
|
||||
keywords: Byte Tracker, Ultralytics STrack, application monitoring, bytes sent, bytes received, code examples, setup instructions
|
||||
---
|
||||
|
||||
## STrack
|
||||
---
|
||||
### ::: ultralytics.tracker.trackers.byte_tracker.STrack
|
||||
<br><br>
|
||||
|
||||
## BYTETracker
|
||||
---
|
||||
### ::: ultralytics.tracker.trackers.byte_tracker.BYTETracker
|
||||
<br><br>
|
@ -1,9 +0,0 @@
|
||||
---
|
||||
description: '"Track Google Marketing Campaigns in GMC with Ultralytics Tracker. Learn to set up and use GMC for detailed analytics. Get started now."'
|
||||
keywords: Ultralytics, YOLO, object detection, tracker, optimization, models, documentation
|
||||
---
|
||||
|
||||
## GMC
|
||||
---
|
||||
### ::: ultralytics.tracker.utils.gmc.GMC
|
||||
<br><br>
|
@ -1,14 +0,0 @@
|
||||
---
|
||||
description: Improve object tracking with KalmanFilterXYAH in Ultralytics YOLO - an efficient and accurate algorithm for state estimation.
|
||||
keywords: KalmanFilterXYAH, Ultralytics Docs, Kalman filter algorithm, object tracking, computer vision, YOLO
|
||||
---
|
||||
|
||||
## KalmanFilterXYAH
|
||||
---
|
||||
### ::: ultralytics.tracker.utils.kalman_filter.KalmanFilterXYAH
|
||||
<br><br>
|
||||
|
||||
## KalmanFilterXYWH
|
||||
---
|
||||
### ::: ultralytics.tracker.utils.kalman_filter.KalmanFilterXYWH
|
||||
<br><br>
|
@ -1,64 +0,0 @@
|
||||
---
|
||||
description: Learn how to match and fuse object detections for accurate target tracking using Ultralytics' YOLO merge_matches, iou_distance, and embedding_distance.
|
||||
keywords: Ultralytics, multi-object tracking, object tracking, detection, recognition, matching, indices, iou distance, gate cost matrix, fuse iou, bbox ious
|
||||
---
|
||||
|
||||
## merge_matches
|
||||
---
|
||||
### ::: ultralytics.tracker.utils.matching.merge_matches
|
||||
<br><br>
|
||||
|
||||
## _indices_to_matches
|
||||
---
|
||||
### ::: ultralytics.tracker.utils.matching._indices_to_matches
|
||||
<br><br>
|
||||
|
||||
## linear_assignment
|
||||
---
|
||||
### ::: ultralytics.tracker.utils.matching.linear_assignment
|
||||
<br><br>
|
||||
|
||||
## ious
|
||||
---
|
||||
### ::: ultralytics.tracker.utils.matching.ious
|
||||
<br><br>
|
||||
|
||||
## iou_distance
|
||||
---
|
||||
### ::: ultralytics.tracker.utils.matching.iou_distance
|
||||
<br><br>
|
||||
|
||||
## v_iou_distance
|
||||
---
|
||||
### ::: ultralytics.tracker.utils.matching.v_iou_distance
|
||||
<br><br>
|
||||
|
||||
## embedding_distance
|
||||
---
|
||||
### ::: ultralytics.tracker.utils.matching.embedding_distance
|
||||
<br><br>
|
||||
|
||||
## gate_cost_matrix
|
||||
---
|
||||
### ::: ultralytics.tracker.utils.matching.gate_cost_matrix
|
||||
<br><br>
|
||||
|
||||
## fuse_motion
|
||||
---
|
||||
### ::: ultralytics.tracker.utils.matching.fuse_motion
|
||||
<br><br>
|
||||
|
||||
## fuse_iou
|
||||
---
|
||||
### ::: ultralytics.tracker.utils.matching.fuse_iou
|
||||
<br><br>
|
||||
|
||||
## fuse_score
|
||||
---
|
||||
### ::: ultralytics.tracker.utils.matching.fuse_score
|
||||
<br><br>
|
||||
|
||||
## bbox_ious
|
||||
---
|
||||
### ::: ultralytics.tracker.utils.matching.bbox_ious
|
||||
<br><br>
|
9
docs/reference/trackers/basetrack.md
Normal file
9
docs/reference/trackers/basetrack.md
Normal file
@ -0,0 +1,9 @@
|
||||
## TrackState
|
||||
---
|
||||
### ::: ultralytics.trackers.basetrack.TrackState
|
||||
<br><br>
|
||||
|
||||
## BaseTrack
|
||||
---
|
||||
### ::: ultralytics.trackers.basetrack.BaseTrack
|
||||
<br><br>
|
9
docs/reference/trackers/bot_sort.md
Normal file
9
docs/reference/trackers/bot_sort.md
Normal file
@ -0,0 +1,9 @@
|
||||
## BOTrack
|
||||
---
|
||||
### ::: ultralytics.trackers.bot_sort.BOTrack
|
||||
<br><br>
|
||||
|
||||
## BOTSORT
|
||||
---
|
||||
### ::: ultralytics.trackers.bot_sort.BOTSORT
|
||||
<br><br>
|
9
docs/reference/trackers/byte_tracker.md
Normal file
9
docs/reference/trackers/byte_tracker.md
Normal file
@ -0,0 +1,9 @@
|
||||
## STrack
|
||||
---
|
||||
### ::: ultralytics.trackers.byte_tracker.STrack
|
||||
<br><br>
|
||||
|
||||
## BYTETracker
|
||||
---
|
||||
### ::: ultralytics.trackers.byte_tracker.BYTETracker
|
||||
<br><br>
|
14
docs/reference/trackers/track.md
Normal file
14
docs/reference/trackers/track.md
Normal file
@ -0,0 +1,14 @@
|
||||
## on_predict_start
|
||||
---
|
||||
### ::: ultralytics.trackers.track.on_predict_start
|
||||
<br><br>
|
||||
|
||||
## on_predict_postprocess_end
|
||||
---
|
||||
### ::: ultralytics.trackers.track.on_predict_postprocess_end
|
||||
<br><br>
|
||||
|
||||
## register_tracker
|
||||
---
|
||||
### ::: ultralytics.trackers.track.register_tracker
|
||||
<br><br>
|
4
docs/reference/trackers/utils/gmc.md
Normal file
4
docs/reference/trackers/utils/gmc.md
Normal file
@ -0,0 +1,4 @@
|
||||
## GMC
|
||||
---
|
||||
### ::: ultralytics.trackers.utils.gmc.GMC
|
||||
<br><br>
|
9
docs/reference/trackers/utils/kalman_filter.md
Normal file
9
docs/reference/trackers/utils/kalman_filter.md
Normal file
@ -0,0 +1,9 @@
|
||||
## KalmanFilterXYAH
|
||||
---
|
||||
### ::: ultralytics.trackers.utils.kalman_filter.KalmanFilterXYAH
|
||||
<br><br>
|
||||
|
||||
## KalmanFilterXYWH
|
||||
---
|
||||
### ::: ultralytics.trackers.utils.kalman_filter.KalmanFilterXYWH
|
||||
<br><br>
|
59
docs/reference/trackers/utils/matching.md
Normal file
59
docs/reference/trackers/utils/matching.md
Normal file
@ -0,0 +1,59 @@
|
||||
## merge_matches
|
||||
---
|
||||
### ::: ultralytics.trackers.utils.matching.merge_matches
|
||||
<br><br>
|
||||
|
||||
## _indices_to_matches
|
||||
---
|
||||
### ::: ultralytics.trackers.utils.matching._indices_to_matches
|
||||
<br><br>
|
||||
|
||||
## linear_assignment
|
||||
---
|
||||
### ::: ultralytics.trackers.utils.matching.linear_assignment
|
||||
<br><br>
|
||||
|
||||
## ious
|
||||
---
|
||||
### ::: ultralytics.trackers.utils.matching.ious
|
||||
<br><br>
|
||||
|
||||
## iou_distance
|
||||
---
|
||||
### ::: ultralytics.trackers.utils.matching.iou_distance
|
||||
<br><br>
|
||||
|
||||
## v_iou_distance
|
||||
---
|
||||
### ::: ultralytics.trackers.utils.matching.v_iou_distance
|
||||
<br><br>
|
||||
|
||||
## embedding_distance
|
||||
---
|
||||
### ::: ultralytics.trackers.utils.matching.embedding_distance
|
||||
<br><br>
|
||||
|
||||
## gate_cost_matrix
|
||||
---
|
||||
### ::: ultralytics.trackers.utils.matching.gate_cost_matrix
|
||||
<br><br>
|
||||
|
||||
## fuse_motion
|
||||
---
|
||||
### ::: ultralytics.trackers.utils.matching.fuse_motion
|
||||
<br><br>
|
||||
|
||||
## fuse_iou
|
||||
---
|
||||
### ::: ultralytics.trackers.utils.matching.fuse_iou
|
||||
<br><br>
|
||||
|
||||
## fuse_score
|
||||
---
|
||||
### ::: ultralytics.trackers.utils.matching.fuse_score
|
||||
<br><br>
|
||||
|
||||
## bbox_ious
|
||||
---
|
||||
### ::: ultralytics.trackers.utils.matching.bbox_ious
|
||||
<br><br>
|
169
docs/reference/utils/__init__.md
Normal file
169
docs/reference/utils/__init__.md
Normal file
@ -0,0 +1,169 @@
|
||||
## SimpleClass
|
||||
---
|
||||
### ::: ultralytics.utils.SimpleClass
|
||||
<br><br>
|
||||
|
||||
## IterableSimpleNamespace
|
||||
---
|
||||
### ::: ultralytics.utils.IterableSimpleNamespace
|
||||
<br><br>
|
||||
|
||||
## EmojiFilter
|
||||
---
|
||||
### ::: ultralytics.utils.EmojiFilter
|
||||
<br><br>
|
||||
|
||||
## ThreadingLocked
|
||||
---
|
||||
### ::: ultralytics.utils.ThreadingLocked
|
||||
<br><br>
|
||||
|
||||
## TryExcept
|
||||
---
|
||||
### ::: ultralytics.utils.TryExcept
|
||||
<br><br>
|
||||
|
||||
## plt_settings
|
||||
---
|
||||
### ::: ultralytics.utils.plt_settings
|
||||
<br><br>
|
||||
|
||||
## set_logging
|
||||
---
|
||||
### ::: ultralytics.utils.set_logging
|
||||
<br><br>
|
||||
|
||||
## emojis
|
||||
---
|
||||
### ::: ultralytics.utils.emojis
|
||||
<br><br>
|
||||
|
||||
## yaml_save
|
||||
---
|
||||
### ::: ultralytics.utils.yaml_save
|
||||
<br><br>
|
||||
|
||||
## yaml_load
|
||||
---
|
||||
### ::: ultralytics.utils.yaml_load
|
||||
<br><br>
|
||||
|
||||
## yaml_print
|
||||
---
|
||||
### ::: ultralytics.utils.yaml_print
|
||||
<br><br>
|
||||
|
||||
## is_colab
|
||||
---
|
||||
### ::: ultralytics.utils.is_colab
|
||||
<br><br>
|
||||
|
||||
## is_kaggle
|
||||
---
|
||||
### ::: ultralytics.utils.is_kaggle
|
||||
<br><br>
|
||||
|
||||
## is_jupyter
|
||||
---
|
||||
### ::: ultralytics.utils.is_jupyter
|
||||
<br><br>
|
||||
|
||||
## is_docker
|
||||
---
|
||||
### ::: ultralytics.utils.is_docker
|
||||
<br><br>
|
||||
|
||||
## is_online
|
||||
---
|
||||
### ::: ultralytics.utils.is_online
|
||||
<br><br>
|
||||
|
||||
## is_pip_package
|
||||
---
|
||||
### ::: ultralytics.utils.is_pip_package
|
||||
<br><br>
|
||||
|
||||
## is_dir_writeable
|
||||
---
|
||||
### ::: ultralytics.utils.is_dir_writeable
|
||||
<br><br>
|
||||
|
||||
## is_pytest_running
|
||||
---
|
||||
### ::: ultralytics.utils.is_pytest_running
|
||||
<br><br>
|
||||
|
||||
## is_github_actions_ci
|
||||
---
|
||||
### ::: ultralytics.utils.is_github_actions_ci
|
||||
<br><br>
|
||||
|
||||
## is_git_dir
|
||||
---
|
||||
### ::: ultralytics.utils.is_git_dir
|
||||
<br><br>
|
||||
|
||||
## get_git_dir
|
||||
---
|
||||
### ::: ultralytics.utils.get_git_dir
|
||||
<br><br>
|
||||
|
||||
## get_git_origin_url
|
||||
---
|
||||
### ::: ultralytics.utils.get_git_origin_url
|
||||
<br><br>
|
||||
|
||||
## get_git_branch
|
||||
---
|
||||
### ::: ultralytics.utils.get_git_branch
|
||||
<br><br>
|
||||
|
||||
## get_default_args
|
||||
---
|
||||
### ::: ultralytics.utils.get_default_args
|
||||
<br><br>
|
||||
|
||||
## get_user_config_dir
|
||||
---
|
||||
### ::: ultralytics.utils.get_user_config_dir
|
||||
<br><br>
|
||||
|
||||
## colorstr
|
||||
---
|
||||
### ::: ultralytics.utils.colorstr
|
||||
<br><br>
|
||||
|
||||
## threaded
|
||||
---
|
||||
### ::: ultralytics.utils.threaded
|
||||
<br><br>
|
||||
|
||||
## set_sentry
|
||||
---
|
||||
### ::: ultralytics.utils.set_sentry
|
||||
<br><br>
|
||||
|
||||
## get_settings
|
||||
---
|
||||
### ::: ultralytics.utils.get_settings
|
||||
<br><br>
|
||||
|
||||
## set_settings
|
||||
---
|
||||
### ::: ultralytics.utils.set_settings
|
||||
<br><br>
|
||||
|
||||
## deprecation_warn
|
||||
---
|
||||
### ::: ultralytics.utils.deprecation_warn
|
||||
<br><br>
|
||||
|
||||
## clean_url
|
||||
---
|
||||
### ::: ultralytics.utils.clean_url
|
||||
<br><br>
|
||||
|
||||
## url2file
|
||||
---
|
||||
### ::: ultralytics.utils.url2file
|
||||
<br><br>
|
9
docs/reference/utils/autobatch.md
Normal file
9
docs/reference/utils/autobatch.md
Normal file
@ -0,0 +1,9 @@
|
||||
## check_train_batch_size
|
||||
---
|
||||
### ::: ultralytics.utils.autobatch.check_train_batch_size
|
||||
<br><br>
|
||||
|
||||
## autobatch
|
||||
---
|
||||
### ::: ultralytics.utils.autobatch.autobatch
|
||||
<br><br>
|
9
docs/reference/utils/benchmarks.md
Normal file
9
docs/reference/utils/benchmarks.md
Normal file
@ -0,0 +1,9 @@
|
||||
## ProfileModels
|
||||
---
|
||||
### ::: ultralytics.utils.benchmarks.ProfileModels
|
||||
<br><br>
|
||||
|
||||
## benchmark
|
||||
---
|
||||
### ::: ultralytics.utils.benchmarks.benchmark
|
||||
<br><br>
|
134
docs/reference/utils/callbacks/base.md
Normal file
134
docs/reference/utils/callbacks/base.md
Normal file
@ -0,0 +1,134 @@
|
||||
## on_pretrain_routine_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_pretrain_routine_start
|
||||
<br><br>
|
||||
|
||||
## on_pretrain_routine_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_pretrain_routine_end
|
||||
<br><br>
|
||||
|
||||
## on_train_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_train_start
|
||||
<br><br>
|
||||
|
||||
## on_train_epoch_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_train_epoch_start
|
||||
<br><br>
|
||||
|
||||
## on_train_batch_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_train_batch_start
|
||||
<br><br>
|
||||
|
||||
## optimizer_step
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.optimizer_step
|
||||
<br><br>
|
||||
|
||||
## on_before_zero_grad
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_before_zero_grad
|
||||
<br><br>
|
||||
|
||||
## on_train_batch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_train_batch_end
|
||||
<br><br>
|
||||
|
||||
## on_train_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_train_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_fit_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_fit_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_model_save
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_model_save
|
||||
<br><br>
|
||||
|
||||
## on_train_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_train_end
|
||||
<br><br>
|
||||
|
||||
## on_params_update
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_params_update
|
||||
<br><br>
|
||||
|
||||
## teardown
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.teardown
|
||||
<br><br>
|
||||
|
||||
## on_val_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_val_start
|
||||
<br><br>
|
||||
|
||||
## on_val_batch_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_val_batch_start
|
||||
<br><br>
|
||||
|
||||
## on_val_batch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_val_batch_end
|
||||
<br><br>
|
||||
|
||||
## on_val_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_val_end
|
||||
<br><br>
|
||||
|
||||
## on_predict_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_predict_start
|
||||
<br><br>
|
||||
|
||||
## on_predict_batch_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_predict_batch_start
|
||||
<br><br>
|
||||
|
||||
## on_predict_batch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_predict_batch_end
|
||||
<br><br>
|
||||
|
||||
## on_predict_postprocess_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_predict_postprocess_end
|
||||
<br><br>
|
||||
|
||||
## on_predict_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_predict_end
|
||||
<br><br>
|
||||
|
||||
## on_export_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_export_start
|
||||
<br><br>
|
||||
|
||||
## on_export_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_export_end
|
||||
<br><br>
|
||||
|
||||
## get_default_callbacks
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.get_default_callbacks
|
||||
<br><br>
|
||||
|
||||
## add_integration_callbacks
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.add_integration_callbacks
|
||||
<br><br>
|
34
docs/reference/utils/callbacks/clearml.md
Normal file
34
docs/reference/utils/callbacks/clearml.md
Normal file
@ -0,0 +1,34 @@
|
||||
## _log_debug_samples
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.clearml._log_debug_samples
|
||||
<br><br>
|
||||
|
||||
## _log_plot
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.clearml._log_plot
|
||||
<br><br>
|
||||
|
||||
## on_pretrain_routine_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.clearml.on_pretrain_routine_start
|
||||
<br><br>
|
||||
|
||||
## on_train_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.clearml.on_train_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_fit_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.clearml.on_fit_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_val_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.clearml.on_val_end
|
||||
<br><br>
|
||||
|
||||
## on_train_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.clearml.on_train_end
|
||||
<br><br>
|
119
docs/reference/utils/callbacks/comet.md
Normal file
119
docs/reference/utils/callbacks/comet.md
Normal file
@ -0,0 +1,119 @@
|
||||
## _get_comet_mode
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._get_comet_mode
|
||||
<br><br>
|
||||
|
||||
## _get_comet_model_name
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._get_comet_model_name
|
||||
<br><br>
|
||||
|
||||
## _get_eval_batch_logging_interval
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._get_eval_batch_logging_interval
|
||||
<br><br>
|
||||
|
||||
## _get_max_image_predictions_to_log
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._get_max_image_predictions_to_log
|
||||
<br><br>
|
||||
|
||||
## _scale_confidence_score
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._scale_confidence_score
|
||||
<br><br>
|
||||
|
||||
## _should_log_confusion_matrix
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._should_log_confusion_matrix
|
||||
<br><br>
|
||||
|
||||
## _should_log_image_predictions
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._should_log_image_predictions
|
||||
<br><br>
|
||||
|
||||
## _get_experiment_type
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._get_experiment_type
|
||||
<br><br>
|
||||
|
||||
## _create_experiment
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._create_experiment
|
||||
<br><br>
|
||||
|
||||
## _fetch_trainer_metadata
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._fetch_trainer_metadata
|
||||
<br><br>
|
||||
|
||||
## _scale_bounding_box_to_original_image_shape
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._scale_bounding_box_to_original_image_shape
|
||||
<br><br>
|
||||
|
||||
## _format_ground_truth_annotations_for_detection
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._format_ground_truth_annotations_for_detection
|
||||
<br><br>
|
||||
|
||||
## _format_prediction_annotations_for_detection
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._format_prediction_annotations_for_detection
|
||||
<br><br>
|
||||
|
||||
## _fetch_annotations
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._fetch_annotations
|
||||
<br><br>
|
||||
|
||||
## _create_prediction_metadata_map
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._create_prediction_metadata_map
|
||||
<br><br>
|
||||
|
||||
## _log_confusion_matrix
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._log_confusion_matrix
|
||||
<br><br>
|
||||
|
||||
## _log_images
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._log_images
|
||||
<br><br>
|
||||
|
||||
## _log_image_predictions
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._log_image_predictions
|
||||
<br><br>
|
||||
|
||||
## _log_plots
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._log_plots
|
||||
<br><br>
|
||||
|
||||
## _log_model
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._log_model
|
||||
<br><br>
|
||||
|
||||
## on_pretrain_routine_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet.on_pretrain_routine_start
|
||||
<br><br>
|
||||
|
||||
## on_train_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet.on_train_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_fit_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet.on_fit_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_train_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet.on_train_end
|
||||
<br><br>
|
49
docs/reference/utils/callbacks/dvc.md
Normal file
49
docs/reference/utils/callbacks/dvc.md
Normal file
@ -0,0 +1,49 @@
|
||||
## _logger_disabled
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.dvc._logger_disabled
|
||||
<br><br>
|
||||
|
||||
## _log_images
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.dvc._log_images
|
||||
<br><br>
|
||||
|
||||
## _log_plots
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.dvc._log_plots
|
||||
<br><br>
|
||||
|
||||
## _log_confusion_matrix
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.dvc._log_confusion_matrix
|
||||
<br><br>
|
||||
|
||||
## on_pretrain_routine_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_start
|
||||
<br><br>
|
||||
|
||||
## on_pretrain_routine_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_end
|
||||
<br><br>
|
||||
|
||||
## on_train_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.dvc.on_train_start
|
||||
<br><br>
|
||||
|
||||
## on_train_epoch_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.dvc.on_train_epoch_start
|
||||
<br><br>
|
||||
|
||||
## on_fit_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.dvc.on_fit_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_train_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.dvc.on_train_end
|
||||
<br><br>
|
39
docs/reference/utils/callbacks/hub.md
Normal file
39
docs/reference/utils/callbacks/hub.md
Normal file
@ -0,0 +1,39 @@
|
||||
## on_pretrain_routine_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.hub.on_pretrain_routine_end
|
||||
<br><br>
|
||||
|
||||
## on_fit_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.hub.on_fit_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_model_save
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.hub.on_model_save
|
||||
<br><br>
|
||||
|
||||
## on_train_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.hub.on_train_end
|
||||
<br><br>
|
||||
|
||||
## on_train_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.hub.on_train_start
|
||||
<br><br>
|
||||
|
||||
## on_val_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.hub.on_val_start
|
||||
<br><br>
|
||||
|
||||
## on_predict_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.hub.on_predict_start
|
||||
<br><br>
|
||||
|
||||
## on_export_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.hub.on_export_start
|
||||
<br><br>
|
14
docs/reference/utils/callbacks/mlflow.md
Normal file
14
docs/reference/utils/callbacks/mlflow.md
Normal file
@ -0,0 +1,14 @@
|
||||
## on_pretrain_routine_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.mlflow.on_pretrain_routine_end
|
||||
<br><br>
|
||||
|
||||
## on_fit_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.mlflow.on_fit_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_train_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.mlflow.on_train_end
|
||||
<br><br>
|
39
docs/reference/utils/callbacks/neptune.md
Normal file
39
docs/reference/utils/callbacks/neptune.md
Normal file
@ -0,0 +1,39 @@
|
||||
## _log_scalars
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.neptune._log_scalars
|
||||
<br><br>
|
||||
|
||||
## _log_images
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.neptune._log_images
|
||||
<br><br>
|
||||
|
||||
## _log_plot
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.neptune._log_plot
|
||||
<br><br>
|
||||
|
||||
## on_pretrain_routine_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.neptune.on_pretrain_routine_start
|
||||
<br><br>
|
||||
|
||||
## on_train_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.neptune.on_train_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_fit_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.neptune.on_fit_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_val_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.neptune.on_val_end
|
||||
<br><br>
|
||||
|
||||
## on_train_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.neptune.on_train_end
|
||||
<br><br>
|
4
docs/reference/utils/callbacks/raytune.md
Normal file
4
docs/reference/utils/callbacks/raytune.md
Normal file
@ -0,0 +1,4 @@
|
||||
## on_fit_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.raytune.on_fit_epoch_end
|
||||
<br><br>
|
19
docs/reference/utils/callbacks/tensorboard.md
Normal file
19
docs/reference/utils/callbacks/tensorboard.md
Normal file
@ -0,0 +1,19 @@
|
||||
## _log_scalars
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.tensorboard._log_scalars
|
||||
<br><br>
|
||||
|
||||
## on_pretrain_routine_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.tensorboard.on_pretrain_routine_start
|
||||
<br><br>
|
||||
|
||||
## on_batch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.tensorboard.on_batch_end
|
||||
<br><br>
|
||||
|
||||
## on_fit_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.tensorboard.on_fit_epoch_end
|
||||
<br><br>
|
24
docs/reference/utils/callbacks/wb.md
Normal file
24
docs/reference/utils/callbacks/wb.md
Normal file
@ -0,0 +1,24 @@
|
||||
## _log_plots
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.wb._log_plots
|
||||
<br><br>
|
||||
|
||||
## on_pretrain_routine_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.wb.on_pretrain_routine_start
|
||||
<br><br>
|
||||
|
||||
## on_fit_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.wb.on_fit_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_train_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.wb.on_train_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_train_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.wb.on_train_end
|
||||
<br><br>
|
89
docs/reference/utils/checks.md
Normal file
89
docs/reference/utils/checks.md
Normal file
@ -0,0 +1,89 @@
|
||||
## is_ascii
|
||||
---
|
||||
### ::: ultralytics.utils.checks.is_ascii
|
||||
<br><br>
|
||||
|
||||
## check_imgsz
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_imgsz
|
||||
<br><br>
|
||||
|
||||
## check_version
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_version
|
||||
<br><br>
|
||||
|
||||
## check_latest_pypi_version
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_latest_pypi_version
|
||||
<br><br>
|
||||
|
||||
## check_pip_update_available
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_pip_update_available
|
||||
<br><br>
|
||||
|
||||
## check_font
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_font
|
||||
<br><br>
|
||||
|
||||
## check_python
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_python
|
||||
<br><br>
|
||||
|
||||
## check_requirements
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_requirements
|
||||
<br><br>
|
||||
|
||||
## check_torchvision
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_torchvision
|
||||
<br><br>
|
||||
|
||||
## check_suffix
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_suffix
|
||||
<br><br>
|
||||
|
||||
## check_yolov5u_filename
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_yolov5u_filename
|
||||
<br><br>
|
||||
|
||||
## check_file
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_file
|
||||
<br><br>
|
||||
|
||||
## check_yaml
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_yaml
|
||||
<br><br>
|
||||
|
||||
## check_imshow
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_imshow
|
||||
<br><br>
|
||||
|
||||
## check_yolo
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_yolo
|
||||
<br><br>
|
||||
|
||||
## check_amp
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_amp
|
||||
<br><br>
|
||||
|
||||
## git_describe
|
||||
---
|
||||
### ::: ultralytics.utils.checks.git_describe
|
||||
<br><br>
|
||||
|
||||
## print_args
|
||||
---
|
||||
### ::: ultralytics.utils.checks.print_args
|
||||
<br><br>
|
19
docs/reference/utils/dist.md
Normal file
19
docs/reference/utils/dist.md
Normal file
@ -0,0 +1,19 @@
|
||||
## find_free_network_port
|
||||
---
|
||||
### ::: ultralytics.utils.dist.find_free_network_port
|
||||
<br><br>
|
||||
|
||||
## generate_ddp_file
|
||||
---
|
||||
### ::: ultralytics.utils.dist.generate_ddp_file
|
||||
<br><br>
|
||||
|
||||
## generate_ddp_command
|
||||
---
|
||||
### ::: ultralytics.utils.dist.generate_ddp_command
|
||||
<br><br>
|
||||
|
||||
## ddp_cleanup
|
||||
---
|
||||
### ::: ultralytics.utils.dist.ddp_cleanup
|
||||
<br><br>
|
34
docs/reference/utils/downloads.md
Normal file
34
docs/reference/utils/downloads.md
Normal file
@ -0,0 +1,34 @@
|
||||
## is_url
|
||||
---
|
||||
### ::: ultralytics.utils.downloads.is_url
|
||||
<br><br>
|
||||
|
||||
## unzip_file
|
||||
---
|
||||
### ::: ultralytics.utils.downloads.unzip_file
|
||||
<br><br>
|
||||
|
||||
## check_disk_space
|
||||
---
|
||||
### ::: ultralytics.utils.downloads.check_disk_space
|
||||
<br><br>
|
||||
|
||||
## safe_download
|
||||
---
|
||||
### ::: ultralytics.utils.downloads.safe_download
|
||||
<br><br>
|
||||
|
||||
## get_github_assets
|
||||
---
|
||||
### ::: ultralytics.utils.downloads.get_github_assets
|
||||
<br><br>
|
||||
|
||||
## attempt_download_asset
|
||||
---
|
||||
### ::: ultralytics.utils.downloads.attempt_download_asset
|
||||
<br><br>
|
||||
|
||||
## download
|
||||
---
|
||||
### ::: ultralytics.utils.downloads.download
|
||||
<br><br>
|
4
docs/reference/utils/errors.md
Normal file
4
docs/reference/utils/errors.md
Normal file
@ -0,0 +1,4 @@
|
||||
## HUBModelError
|
||||
---
|
||||
### ::: ultralytics.utils.errors.HUBModelError
|
||||
<br><br>
|
34
docs/reference/utils/files.md
Normal file
34
docs/reference/utils/files.md
Normal file
@ -0,0 +1,34 @@
|
||||
## WorkingDirectory
|
||||
---
|
||||
### ::: ultralytics.utils.files.WorkingDirectory
|
||||
<br><br>
|
||||
|
||||
## increment_path
|
||||
---
|
||||
### ::: ultralytics.utils.files.increment_path
|
||||
<br><br>
|
||||
|
||||
## file_age
|
||||
---
|
||||
### ::: ultralytics.utils.files.file_age
|
||||
<br><br>
|
||||
|
||||
## file_date
|
||||
---
|
||||
### ::: ultralytics.utils.files.file_date
|
||||
<br><br>
|
||||
|
||||
## file_size
|
||||
---
|
||||
### ::: ultralytics.utils.files.file_size
|
||||
<br><br>
|
||||
|
||||
## get_latest_run
|
||||
---
|
||||
### ::: ultralytics.utils.files.get_latest_run
|
||||
<br><br>
|
||||
|
||||
## make_dirs
|
||||
---
|
||||
### ::: ultralytics.utils.files.make_dirs
|
||||
<br><br>
|
14
docs/reference/utils/instance.md
Normal file
14
docs/reference/utils/instance.md
Normal file
@ -0,0 +1,14 @@
|
||||
## Bboxes
|
||||
---
|
||||
### ::: ultralytics.utils.instance.Bboxes
|
||||
<br><br>
|
||||
|
||||
## Instances
|
||||
---
|
||||
### ::: ultralytics.utils.instance.Instances
|
||||
<br><br>
|
||||
|
||||
## _ntuple
|
||||
---
|
||||
### ::: ultralytics.utils.instance._ntuple
|
||||
<br><br>
|
39
docs/reference/utils/loss.md
Normal file
39
docs/reference/utils/loss.md
Normal file
@ -0,0 +1,39 @@
|
||||
## VarifocalLoss
|
||||
---
|
||||
### ::: ultralytics.utils.loss.VarifocalLoss
|
||||
<br><br>
|
||||
|
||||
## FocalLoss
|
||||
---
|
||||
### ::: ultralytics.utils.loss.FocalLoss
|
||||
<br><br>
|
||||
|
||||
## BboxLoss
|
||||
---
|
||||
### ::: ultralytics.utils.loss.BboxLoss
|
||||
<br><br>
|
||||
|
||||
## KeypointLoss
|
||||
---
|
||||
### ::: ultralytics.utils.loss.KeypointLoss
|
||||
<br><br>
|
||||
|
||||
## v8DetectionLoss
|
||||
---
|
||||
### ::: ultralytics.utils.loss.v8DetectionLoss
|
||||
<br><br>
|
||||
|
||||
## v8SegmentationLoss
|
||||
---
|
||||
### ::: ultralytics.utils.loss.v8SegmentationLoss
|
||||
<br><br>
|
||||
|
||||
## v8PoseLoss
|
||||
---
|
||||
### ::: ultralytics.utils.loss.v8PoseLoss
|
||||
<br><br>
|
||||
|
||||
## v8ClassificationLoss
|
||||
---
|
||||
### ::: ultralytics.utils.loss.v8ClassificationLoss
|
||||
<br><br>
|
89
docs/reference/utils/metrics.md
Normal file
89
docs/reference/utils/metrics.md
Normal file
@ -0,0 +1,89 @@
|
||||
## ConfusionMatrix
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.ConfusionMatrix
|
||||
<br><br>
|
||||
|
||||
## Metric
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.Metric
|
||||
<br><br>
|
||||
|
||||
## DetMetrics
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.DetMetrics
|
||||
<br><br>
|
||||
|
||||
## SegmentMetrics
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.SegmentMetrics
|
||||
<br><br>
|
||||
|
||||
## PoseMetrics
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.PoseMetrics
|
||||
<br><br>
|
||||
|
||||
## ClassifyMetrics
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.ClassifyMetrics
|
||||
<br><br>
|
||||
|
||||
## box_area
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.box_area
|
||||
<br><br>
|
||||
|
||||
## bbox_ioa
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.bbox_ioa
|
||||
<br><br>
|
||||
|
||||
## box_iou
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.box_iou
|
||||
<br><br>
|
||||
|
||||
## bbox_iou
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.bbox_iou
|
||||
<br><br>
|
||||
|
||||
## mask_iou
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.mask_iou
|
||||
<br><br>
|
||||
|
||||
## kpt_iou
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.kpt_iou
|
||||
<br><br>
|
||||
|
||||
## smooth_BCE
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.smooth_BCE
|
||||
<br><br>
|
||||
|
||||
## smooth
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.smooth
|
||||
<br><br>
|
||||
|
||||
## plot_pr_curve
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.plot_pr_curve
|
||||
<br><br>
|
||||
|
||||
## plot_mc_curve
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.plot_mc_curve
|
||||
<br><br>
|
||||
|
||||
## compute_ap
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.compute_ap
|
||||
<br><br>
|
||||
|
||||
## ap_per_class
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.ap_per_class
|
||||
<br><br>
|
139
docs/reference/utils/ops.md
Normal file
139
docs/reference/utils/ops.md
Normal file
@ -0,0 +1,139 @@
|
||||
## Profile
|
||||
---
|
||||
### ::: ultralytics.utils.ops.Profile
|
||||
<br><br>
|
||||
|
||||
## coco80_to_coco91_class
|
||||
---
|
||||
### ::: ultralytics.utils.ops.coco80_to_coco91_class
|
||||
<br><br>
|
||||
|
||||
## segment2box
|
||||
---
|
||||
### ::: ultralytics.utils.ops.segment2box
|
||||
<br><br>
|
||||
|
||||
## scale_boxes
|
||||
---
|
||||
### ::: ultralytics.utils.ops.scale_boxes
|
||||
<br><br>
|
||||
|
||||
## make_divisible
|
||||
---
|
||||
### ::: ultralytics.utils.ops.make_divisible
|
||||
<br><br>
|
||||
|
||||
## non_max_suppression
|
||||
---
|
||||
### ::: ultralytics.utils.ops.non_max_suppression
|
||||
<br><br>
|
||||
|
||||
## clip_boxes
|
||||
---
|
||||
### ::: ultralytics.utils.ops.clip_boxes
|
||||
<br><br>
|
||||
|
||||
## clip_coords
|
||||
---
|
||||
### ::: ultralytics.utils.ops.clip_coords
|
||||
<br><br>
|
||||
|
||||
## scale_image
|
||||
---
|
||||
### ::: ultralytics.utils.ops.scale_image
|
||||
<br><br>
|
||||
|
||||
## xyxy2xywh
|
||||
---
|
||||
### ::: ultralytics.utils.ops.xyxy2xywh
|
||||
<br><br>
|
||||
|
||||
## xywh2xyxy
|
||||
---
|
||||
### ::: ultralytics.utils.ops.xywh2xyxy
|
||||
<br><br>
|
||||
|
||||
## xywhn2xyxy
|
||||
---
|
||||
### ::: ultralytics.utils.ops.xywhn2xyxy
|
||||
<br><br>
|
||||
|
||||
## xyxy2xywhn
|
||||
---
|
||||
### ::: ultralytics.utils.ops.xyxy2xywhn
|
||||
<br><br>
|
||||
|
||||
## xyn2xy
|
||||
---
|
||||
### ::: ultralytics.utils.ops.xyn2xy
|
||||
<br><br>
|
||||
|
||||
## xywh2ltwh
|
||||
---
|
||||
### ::: ultralytics.utils.ops.xywh2ltwh
|
||||
<br><br>
|
||||
|
||||
## xyxy2ltwh
|
||||
---
|
||||
### ::: ultralytics.utils.ops.xyxy2ltwh
|
||||
<br><br>
|
||||
|
||||
## ltwh2xywh
|
||||
---
|
||||
### ::: ultralytics.utils.ops.ltwh2xywh
|
||||
<br><br>
|
||||
|
||||
## ltwh2xyxy
|
||||
---
|
||||
### ::: ultralytics.utils.ops.ltwh2xyxy
|
||||
<br><br>
|
||||
|
||||
## segments2boxes
|
||||
---
|
||||
### ::: ultralytics.utils.ops.segments2boxes
|
||||
<br><br>
|
||||
|
||||
## resample_segments
|
||||
---
|
||||
### ::: ultralytics.utils.ops.resample_segments
|
||||
<br><br>
|
||||
|
||||
## crop_mask
|
||||
---
|
||||
### ::: ultralytics.utils.ops.crop_mask
|
||||
<br><br>
|
||||
|
||||
## process_mask_upsample
|
||||
---
|
||||
### ::: ultralytics.utils.ops.process_mask_upsample
|
||||
<br><br>
|
||||
|
||||
## process_mask
|
||||
---
|
||||
### ::: ultralytics.utils.ops.process_mask
|
||||
<br><br>
|
||||
|
||||
## process_mask_native
|
||||
---
|
||||
### ::: ultralytics.utils.ops.process_mask_native
|
||||
<br><br>
|
||||
|
||||
## scale_masks
|
||||
---
|
||||
### ::: ultralytics.utils.ops.scale_masks
|
||||
<br><br>
|
||||
|
||||
## scale_coords
|
||||
---
|
||||
### ::: ultralytics.utils.ops.scale_coords
|
||||
<br><br>
|
||||
|
||||
## masks2segments
|
||||
---
|
||||
### ::: ultralytics.utils.ops.masks2segments
|
||||
<br><br>
|
||||
|
||||
## clean_str
|
||||
---
|
||||
### ::: ultralytics.utils.ops.clean_str
|
||||
<br><br>
|
19
docs/reference/utils/patches.md
Normal file
19
docs/reference/utils/patches.md
Normal file
@ -0,0 +1,19 @@
|
||||
## imread
|
||||
---
|
||||
### ::: ultralytics.utils.patches.imread
|
||||
<br><br>
|
||||
|
||||
## imwrite
|
||||
---
|
||||
### ::: ultralytics.utils.patches.imwrite
|
||||
<br><br>
|
||||
|
||||
## imshow
|
||||
---
|
||||
### ::: ultralytics.utils.patches.imshow
|
||||
<br><br>
|
||||
|
||||
## torch_save
|
||||
---
|
||||
### ::: ultralytics.utils.patches.torch_save
|
||||
<br><br>
|
39
docs/reference/utils/plotting.md
Normal file
39
docs/reference/utils/plotting.md
Normal file
@ -0,0 +1,39 @@
|
||||
## Colors
|
||||
---
|
||||
### ::: ultralytics.utils.plotting.Colors
|
||||
<br><br>
|
||||
|
||||
## Annotator
|
||||
---
|
||||
### ::: ultralytics.utils.plotting.Annotator
|
||||
<br><br>
|
||||
|
||||
## plot_labels
|
||||
---
|
||||
### ::: ultralytics.utils.plotting.plot_labels
|
||||
<br><br>
|
||||
|
||||
## save_one_box
|
||||
---
|
||||
### ::: ultralytics.utils.plotting.save_one_box
|
||||
<br><br>
|
||||
|
||||
## plot_images
|
||||
---
|
||||
### ::: ultralytics.utils.plotting.plot_images
|
||||
<br><br>
|
||||
|
||||
## plot_results
|
||||
---
|
||||
### ::: ultralytics.utils.plotting.plot_results
|
||||
<br><br>
|
||||
|
||||
## output_to_target
|
||||
---
|
||||
### ::: ultralytics.utils.plotting.output_to_target
|
||||
<br><br>
|
||||
|
||||
## feature_visualization
|
||||
---
|
||||
### ::: ultralytics.utils.plotting.feature_visualization
|
||||
<br><br>
|
29
docs/reference/utils/tal.md
Normal file
29
docs/reference/utils/tal.md
Normal file
@ -0,0 +1,29 @@
|
||||
## TaskAlignedAssigner
|
||||
---
|
||||
### ::: ultralytics.utils.tal.TaskAlignedAssigner
|
||||
<br><br>
|
||||
|
||||
## select_candidates_in_gts
|
||||
---
|
||||
### ::: ultralytics.utils.tal.select_candidates_in_gts
|
||||
<br><br>
|
||||
|
||||
## select_highest_overlaps
|
||||
---
|
||||
### ::: ultralytics.utils.tal.select_highest_overlaps
|
||||
<br><br>
|
||||
|
||||
## make_anchors
|
||||
---
|
||||
### ::: ultralytics.utils.tal.make_anchors
|
||||
<br><br>
|
||||
|
||||
## dist2bbox
|
||||
---
|
||||
### ::: ultralytics.utils.tal.dist2bbox
|
||||
<br><br>
|
||||
|
||||
## bbox2dist
|
||||
---
|
||||
### ::: ultralytics.utils.tal.bbox2dist
|
||||
<br><br>
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user