Update more/missing type qualifiers to lowercase MkDocs admonitions (#16215)
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>
This commit is contained in:
parent
6b95967e08
commit
b9f0983e82
148 changed files with 223 additions and 223 deletions
|
|
@ -5,7 +5,7 @@ keywords: Ultralytics, utils, TQDM, Python, ML, Machine Learning utilities, YOLO
|
|||
|
||||
# Reference for `ultralytics/utils/__init__.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/\_\_init\_\_.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/__init__.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/__init__.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: YOLO batch size, CUDA memory, PyTorch autobatch, Ultralytics, machine
|
|||
|
||||
# Reference for `ultralytics/utils/autobatch.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/autobatch.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/autobatch.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/autobatch.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: YOLO, model benchmarking, ONNX, TensorRT, PyTorch, TensorFlow, CoreML,
|
|||
|
||||
# Reference for `ultralytics/utils/benchmarks.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/benchmarks.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/benchmarks.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/benchmarks.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: Ultralytics, base callbacks, training, validation, prediction, model e
|
|||
|
||||
# Reference for `ultralytics/utils/callbacks/base.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/base.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/base.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/base.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: Ultralytics, YOLO, ClearML, integration, callbacks, pretraining, train
|
|||
|
||||
# Reference for `ultralytics/utils/callbacks/clearml.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/clearml.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/clearml.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/clearml.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: Ultralytics, YOLO, Comet, callbacks, logging, machine learning, monito
|
|||
|
||||
# Reference for `ultralytics/utils/callbacks/comet.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/comet.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/comet.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/comet.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: Ultralytics, DVC, DVCLive, machine learning, logging, training, callba
|
|||
|
||||
# Reference for `ultralytics/utils/callbacks/dvc.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/dvc.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/dvc.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/dvc.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: Ultralytics, callbacks, pretrain, model save, train start, train end,
|
|||
|
||||
# Reference for `ultralytics/utils/callbacks/hub.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/hub.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/hub.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/hub.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: MLflow, Ultralytics YOLO, logging, metrics, parameters, model artifact
|
|||
|
||||
# Reference for `ultralytics/utils/callbacks/mlflow.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/mlflow.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/mlflow.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/mlflow.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: Ultralytics, NeptuneAI, YOLO, experiment logging, machine learning, AI
|
|||
|
||||
# Reference for `ultralytics/utils/callbacks/neptune.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/neptune.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/neptune.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/neptune.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: Ultralytics, Ray Tune, hyperparameter tuning, YOLO, machine learning,
|
|||
|
||||
# Reference for `ultralytics/utils/callbacks/raytune.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/raytune.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/raytune.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/raytune.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: Ultralytics, TensorBoard, callbacks, machine learning, training visual
|
|||
|
||||
# Reference for `ultralytics/utils/callbacks/tensorboard.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/tensorboard.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/tensorboard.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/tensorboard.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: Ultralytics, YOLO, WandB, callbacks, logging, metrics, visualizations,
|
|||
|
||||
# Reference for `ultralytics/utils/callbacks/wb.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/wb.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/wb.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/wb.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: Ultralytics, YOLO, utility functions, version checks, requirements, im
|
|||
|
||||
# Reference for `ultralytics/utils/checks.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/checks.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/checks.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/checks.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: Ultralytics, distributed training, DDP, multi-node training, network p
|
|||
|
||||
# Reference for `ultralytics/utils/dist.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/dist.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/dist.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/dist.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: Ultralytics, download utilities, URL validation, zip directory, unzip
|
|||
|
||||
# Reference for `ultralytics/utils/downloads.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/downloads.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/downloads.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/downloads.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: Ultralytics, YOLO, error handling, HUBModelError, model fetching, cust
|
|||
|
||||
# Reference for `ultralytics/utils/errors.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/errors.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/errors.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/errors.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: Ultralytics, file utilities, Python, WorkingDirectory, increment_path,
|
|||
|
||||
# Reference for `ultralytics/utils/files.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/files.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/files.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/files.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: Ultralytics, bounding boxes, Instances, bbox formats, conversions, AI,
|
|||
|
||||
# Reference for `ultralytics/utils/instance.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/instance.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/instance.py). 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/instance.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: Ultralytics, loss functions, Varifocal Loss, Focal Loss, Bbox Loss, Ro
|
|||
|
||||
# Reference for `ultralytics/utils/loss.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/loss.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/loss.py). 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/loss.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: Ultralytics, metrics, model validation, performance analysis, IoU, con
|
|||
|
||||
# Reference for `ultralytics/utils/metrics.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/metrics.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/metrics.py). 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/metrics.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: Ultralytics, utility operations, non-max suppression, bounding box tra
|
|||
|
||||
# Reference for `ultralytics/utils/ops.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/ops.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/ops.py). 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/ops.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: Ultralytics, utils, patches, imread, imwrite, imshow, torch_save, Open
|
|||
|
||||
# Reference for `ultralytics/utils/patches.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/patches.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/patches.py). 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/patches.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: ultralytics, plotting, utilities, documentation, data visualization, a
|
|||
|
||||
# Reference for `ultralytics/utils/plotting.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/plotting.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/plotting.py). 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/plotting.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: Ultralytics, YOLO, TaskAlignedAssigner, object detection, machine lear
|
|||
|
||||
# Reference for `ultralytics/utils/tal.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/tal.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/tal.py). 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/tal.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: Ultralytics, torch utils, model optimization, device selection, infere
|
|||
|
||||
# Reference for `ultralytics/utils/torch_utils.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/torch_utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/torch_utils.py). 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/torch_utils.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: Ultralytics, TritonRemoteModel, Triton Inference Server, model client,
|
|||
|
||||
# Reference for `ultralytics/utils/triton.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/triton.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/triton.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/triton.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ keywords: Ultralytics, tuner, hyperparameter tuning, Ray Tune, YOLO, machine lea
|
|||
|
||||
# Reference for `ultralytics/utils/tuner.py`
|
||||
|
||||
!!! Note
|
||||
!!! note
|
||||
|
||||
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/tuner.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/tuner.py). 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/tuner.py) 🛠️. Thank you 🙏!
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue