From 0a229bd40feed11815616a906632e53aaef4ed05 Mon Sep 17 00:00:00 2001 From: Glenn Jocher Date: Thu, 15 Jun 2023 21:44:25 +0200 Subject: [PATCH] Add patches section and fix Docs CI (#3193) --- .github/workflows/publish.yml | 2 +- docs/reference/hub/auth.md | 2 +- docs/reference/hub/session.md | 2 +- docs/reference/hub/utils.md | 2 +- docs/reference/nn/autobackend.md | 2 +- docs/reference/nn/autoshape.md | 2 +- docs/reference/nn/modules/block.md | 2 +- docs/reference/nn/modules/conv.md | 2 +- docs/reference/nn/modules/head.md | 2 +- docs/reference/nn/modules/transformer.md | 2 +- docs/reference/nn/modules/utils.md | 2 +- docs/reference/nn/tasks.md | 2 +- docs/reference/tracker/track.md | 2 +- docs/reference/tracker/trackers/basetrack.md | 2 +- docs/reference/tracker/trackers/bot_sort.md | 2 +- .../tracker/trackers/byte_tracker.md | 2 +- docs/reference/tracker/utils/gmc.md | 2 +- docs/reference/tracker/utils/kalman_filter.md | 2 +- docs/reference/tracker/utils/matching.md | 2 +- docs/reference/yolo/data/annotator.md | 2 +- docs/reference/yolo/data/augment.md | 2 +- docs/reference/yolo/data/base.md | 2 +- docs/reference/yolo/data/build.md | 2 +- docs/reference/yolo/data/converter.md | 2 +- .../yolo/data/dataloaders/stream_loaders.md | 2 +- .../yolo/data/dataloaders/v5augmentations.md | 2 +- .../yolo/data/dataloaders/v5loader.md | 2 +- docs/reference/yolo/data/dataset.md | 2 +- docs/reference/yolo/data/dataset_wrappers.md | 2 +- docs/reference/yolo/data/utils.md | 2 +- docs/reference/yolo/engine/exporter.md | 2 +- docs/reference/yolo/engine/model.md | 2 +- docs/reference/yolo/engine/predictor.md | 2 +- docs/reference/yolo/engine/results.md | 2 +- docs/reference/yolo/engine/trainer.md | 2 +- docs/reference/yolo/engine/validator.md | 2 +- docs/reference/yolo/nas/model.md | 2 +- docs/reference/yolo/nas/predict.md | 2 +- docs/reference/yolo/nas/val.md | 2 +- docs/reference/yolo/utils/autobatch.md | 2 +- docs/reference/yolo/utils/benchmarks.md | 2 +- docs/reference/yolo/utils/callbacks/base.md | 2 +- .../reference/yolo/utils/callbacks/clearml.md | 2 +- docs/reference/yolo/utils/callbacks/comet.md | 2 +- docs/reference/yolo/utils/callbacks/dvc.md | 2 +- docs/reference/yolo/utils/callbacks/hub.md | 2 +- docs/reference/yolo/utils/callbacks/mlflow.md | 2 +- .../reference/yolo/utils/callbacks/neptune.md | 2 +- .../reference/yolo/utils/callbacks/raytune.md | 2 +- .../yolo/utils/callbacks/tensorboard.md | 2 +- docs/reference/yolo/utils/callbacks/wb.md | 2 +- docs/reference/yolo/utils/checks.md | 2 +- docs/reference/yolo/utils/dist.md | 2 +- docs/reference/yolo/utils/downloads.md | 2 +- docs/reference/yolo/utils/errors.md | 2 +- docs/reference/yolo/utils/files.md | 2 +- docs/reference/yolo/utils/instance.md | 2 +- docs/reference/yolo/utils/loss.md | 2 +- docs/reference/yolo/utils/metrics.md | 2 +- docs/reference/yolo/utils/ops.md | 2 +- docs/reference/yolo/utils/patches.md | 24 +++++++++++++++++++ docs/reference/yolo/utils/plotting.md | 2 +- docs/reference/yolo/utils/tal.md | 2 +- docs/reference/yolo/utils/torch_utils.md | 2 +- docs/reference/yolo/v8/classify/predict.md | 2 +- docs/reference/yolo/v8/classify/train.md | 2 +- docs/reference/yolo/v8/classify/val.md | 2 +- docs/reference/yolo/v8/detect/predict.md | 2 +- docs/reference/yolo/v8/detect/train.md | 2 +- docs/reference/yolo/v8/detect/val.md | 2 +- docs/reference/yolo/v8/pose/predict.md | 2 +- docs/reference/yolo/v8/pose/train.md | 2 +- docs/reference/yolo/v8/pose/val.md | 2 +- docs/reference/yolo/v8/segment/predict.md | 2 +- docs/reference/yolo/v8/segment/train.md | 2 +- docs/reference/yolo/v8/segment/val.md | 2 +- 76 files changed, 99 insertions(+), 75 deletions(-) create mode 100644 docs/reference/yolo/utils/patches.md diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index ae759ecd6..72e221687 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -63,7 +63,7 @@ jobs: python -m twine upload dist/* -u __token__ -p $PYPI_TOKEN - name: Deploy Docs continue-on-error: true - if: ((github.event_name == 'push' && (contains(github.event.head_commit.message, 'docs/') || contains(github.event.head_commit.message, 'mkdocs.yaml'))) || github.event.inputs.docs == 'true') && github.repository == 'ultralytics/ultralytics' && github.actor == 'glenn-jocher' + if: (github.event_name == 'push' || github.event.inputs.docs == 'true') && github.repository == 'ultralytics/ultralytics' && github.actor == 'glenn-jocher' env: PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }} run: | diff --git a/docs/reference/hub/auth.md b/docs/reference/hub/auth.md index a8b7f9dbe..6090034fa 100644 --- a/docs/reference/hub/auth.md +++ b/docs/reference/hub/auth.md @@ -6,4 +6,4 @@ keywords: Ultralytics, ultralytics hub, api keys, authentication, collab account # Auth --- :::ultralytics.hub.auth.Auth -

\ No newline at end of file +

diff --git a/docs/reference/hub/session.md b/docs/reference/hub/session.md index 3b2115ca5..c8c1d9e83 100644 --- a/docs/reference/hub/session.md +++ b/docs/reference/hub/session.md @@ -6,4 +6,4 @@ keywords: YOLOv5, object detection, HUBTrainingSession, custom models, Ultralyti # HUBTrainingSession --- :::ultralytics.hub.session.HUBTrainingSession -

\ No newline at end of file +

diff --git a/docs/reference/hub/utils.md b/docs/reference/hub/utils.md index bacefc845..6a91ab8e5 100644 --- a/docs/reference/hub/utils.md +++ b/docs/reference/hub/utils.md @@ -21,4 +21,4 @@ keywords: Ultralytics, Hub Utils, API Documentation, Python, requests_with_progr # smart_request --- :::ultralytics.hub.utils.smart_request -

\ No newline at end of file +

diff --git a/docs/reference/nn/autobackend.md b/docs/reference/nn/autobackend.md index 9feb71b03..0db7e0650 100644 --- a/docs/reference/nn/autobackend.md +++ b/docs/reference/nn/autobackend.md @@ -11,4 +11,4 @@ keywords: AutoBackend, ultralytics, nn, autobackend, check class names, neural n # check_class_names --- :::ultralytics.nn.autobackend.check_class_names -

\ No newline at end of file +

diff --git a/docs/reference/nn/autoshape.md b/docs/reference/nn/autoshape.md index e17976ef8..4562f6d29 100644 --- a/docs/reference/nn/autoshape.md +++ b/docs/reference/nn/autoshape.md @@ -11,4 +11,4 @@ keywords: Ultralytics, YOLO, docs, autoshape, detections, object detection, cust # Detections --- :::ultralytics.nn.autoshape.Detections -

\ No newline at end of file +

diff --git a/docs/reference/nn/modules/block.md b/docs/reference/nn/modules/block.md index 687e30803..32c97a1c7 100644 --- a/docs/reference/nn/modules/block.md +++ b/docs/reference/nn/modules/block.md @@ -86,4 +86,4 @@ keywords: Ultralytics, NN Modules, Blocks, DFL, HGStem, SPP, C1, C2f, C3x, C3TR, # BottleneckCSP --- :::ultralytics.nn.modules.block.BottleneckCSP -

\ No newline at end of file +

diff --git a/docs/reference/nn/modules/conv.md b/docs/reference/nn/modules/conv.md index 60d0345f4..eeeccc8f9 100644 --- a/docs/reference/nn/modules/conv.md +++ b/docs/reference/nn/modules/conv.md @@ -71,4 +71,4 @@ keywords: Ultralytics, Convolutional Neural Network, Conv2, DWConv, ConvTranspos # autopad --- :::ultralytics.nn.modules.conv.autopad -

\ No newline at end of file +

diff --git a/docs/reference/nn/modules/head.md b/docs/reference/nn/modules/head.md index b21124e21..4f3597676 100644 --- a/docs/reference/nn/modules/head.md +++ b/docs/reference/nn/modules/head.md @@ -26,4 +26,4 @@ keywords: Ultralytics, YOLO, object detection, pose estimation, RTDETRDecoder, m # RTDETRDecoder --- :::ultralytics.nn.modules.head.RTDETRDecoder -

\ No newline at end of file +

diff --git a/docs/reference/nn/modules/transformer.md b/docs/reference/nn/modules/transformer.md index 8d6429d73..17aee1da9 100644 --- a/docs/reference/nn/modules/transformer.md +++ b/docs/reference/nn/modules/transformer.md @@ -51,4 +51,4 @@ keywords: Ultralytics, NN Modules, TransformerEncoderLayer, TransformerLayer, ML # DeformableTransformerDecoder --- :::ultralytics.nn.modules.transformer.DeformableTransformerDecoder -

\ No newline at end of file +

diff --git a/docs/reference/nn/modules/utils.md b/docs/reference/nn/modules/utils.md index f7aa43f0d..34f68172f 100644 --- a/docs/reference/nn/modules/utils.md +++ b/docs/reference/nn/modules/utils.md @@ -26,4 +26,4 @@ keywords: Ultralytics, NN Utils, Docs, PyTorch, bias initialization, linear init # multi_scale_deformable_attn_pytorch --- :::ultralytics.nn.modules.utils.multi_scale_deformable_attn_pytorch -

\ No newline at end of file +

diff --git a/docs/reference/nn/tasks.md b/docs/reference/nn/tasks.md index 3258e4ff9..9d8327ab3 100644 --- a/docs/reference/nn/tasks.md +++ b/docs/reference/nn/tasks.md @@ -71,4 +71,4 @@ keywords: neural network, deep learning, computer vision, object detection, imag # guess_model_task --- :::ultralytics.nn.tasks.guess_model_task -

\ No newline at end of file +

diff --git a/docs/reference/tracker/track.md b/docs/reference/tracker/track.md index 156ee0002..b7af3db1e 100644 --- a/docs/reference/tracker/track.md +++ b/docs/reference/tracker/track.md @@ -16,4 +16,4 @@ keywords: Ultralytics YOLO, tracker registration, on_predict_start, object detec # register_tracker --- :::ultralytics.tracker.track.register_tracker -

\ No newline at end of file +

diff --git a/docs/reference/tracker/trackers/basetrack.md b/docs/reference/tracker/trackers/basetrack.md index 9b767eca3..6b3317b44 100644 --- a/docs/reference/tracker/trackers/basetrack.md +++ b/docs/reference/tracker/trackers/basetrack.md @@ -11,4 +11,4 @@ keywords: object detection, object tracking, Ultralytics YOLO, TrackState, workf # BaseTrack --- :::ultralytics.tracker.trackers.basetrack.BaseTrack -

\ No newline at end of file +

diff --git a/docs/reference/tracker/trackers/bot_sort.md b/docs/reference/tracker/trackers/bot_sort.md index f3f50132e..72cdaeb23 100644 --- a/docs/reference/tracker/trackers/bot_sort.md +++ b/docs/reference/tracker/trackers/bot_sort.md @@ -11,4 +11,4 @@ keywords: BOTrack, Ultralytics YOLO Docs, features, usage # BOTSORT --- :::ultralytics.tracker.trackers.bot_sort.BOTSORT -

\ No newline at end of file +

diff --git a/docs/reference/tracker/trackers/byte_tracker.md b/docs/reference/tracker/trackers/byte_tracker.md index cbaf90a91..8d3032f78 100644 --- a/docs/reference/tracker/trackers/byte_tracker.md +++ b/docs/reference/tracker/trackers/byte_tracker.md @@ -11,4 +11,4 @@ keywords: Byte Tracker, Ultralytics STrack, application monitoring, bytes sent, # BYTETracker --- :::ultralytics.tracker.trackers.byte_tracker.BYTETracker -

\ No newline at end of file +

diff --git a/docs/reference/tracker/utils/gmc.md b/docs/reference/tracker/utils/gmc.md index 461b7fd88..ef4d9a286 100644 --- a/docs/reference/tracker/utils/gmc.md +++ b/docs/reference/tracker/utils/gmc.md @@ -6,4 +6,4 @@ keywords: Ultralytics, YOLO, object detection, tracker, optimization, models, do # GMC --- :::ultralytics.tracker.utils.gmc.GMC -

\ No newline at end of file +

diff --git a/docs/reference/tracker/utils/kalman_filter.md b/docs/reference/tracker/utils/kalman_filter.md index 93217151c..83fd607c3 100644 --- a/docs/reference/tracker/utils/kalman_filter.md +++ b/docs/reference/tracker/utils/kalman_filter.md @@ -11,4 +11,4 @@ keywords: KalmanFilterXYAH, Ultralytics Docs, Kalman filter algorithm, object tr # KalmanFilterXYWH --- :::ultralytics.tracker.utils.kalman_filter.KalmanFilterXYWH -

\ No newline at end of file +

diff --git a/docs/reference/tracker/utils/matching.md b/docs/reference/tracker/utils/matching.md index 4f1725dbb..3ae6d773e 100644 --- a/docs/reference/tracker/utils/matching.md +++ b/docs/reference/tracker/utils/matching.md @@ -61,4 +61,4 @@ keywords: Ultralytics, multi-object tracking, object tracking, detection, recogn # bbox_ious --- :::ultralytics.tracker.utils.matching.bbox_ious -

\ No newline at end of file +

diff --git a/docs/reference/yolo/data/annotator.md b/docs/reference/yolo/data/annotator.md index 25ca21aaf..efb61d672 100644 --- a/docs/reference/yolo/data/annotator.md +++ b/docs/reference/yolo/data/annotator.md @@ -6,4 +6,4 @@ keywords: Ultralytics YOLO, Auto Annotator, AI, image annotation, object detecti # auto_annotate --- :::ultralytics.yolo.data.annotator.auto_annotate -

\ No newline at end of file +

diff --git a/docs/reference/yolo/data/augment.md b/docs/reference/yolo/data/augment.md index 1bff44f60..17241df5a 100644 --- a/docs/reference/yolo/data/augment.md +++ b/docs/reference/yolo/data/augment.md @@ -96,4 +96,4 @@ keywords: YOLO, data augmentation, transforms, BaseTransform, MixUp, RandomHSV, # classify_albumentations --- :::ultralytics.yolo.data.augment.classify_albumentations -

\ No newline at end of file +

diff --git a/docs/reference/yolo/data/base.md b/docs/reference/yolo/data/base.md index eb6defed2..6b615b39a 100644 --- a/docs/reference/yolo/data/base.md +++ b/docs/reference/yolo/data/base.md @@ -6,4 +6,4 @@ keywords: BaseDataset, Ultralytics YOLO, object detection, real-world applicatio # BaseDataset --- :::ultralytics.yolo.data.base.BaseDataset -

\ No newline at end of file +

diff --git a/docs/reference/yolo/data/build.md b/docs/reference/yolo/data/build.md index d1f050844..74321081d 100644 --- a/docs/reference/yolo/data/build.md +++ b/docs/reference/yolo/data/build.md @@ -36,4 +36,4 @@ keywords: Ultralytics, YOLO, object detection, data loading, build dataloader, l # load_inference_source --- :::ultralytics.yolo.data.build.load_inference_source -

\ No newline at end of file +

diff --git a/docs/reference/yolo/data/converter.md b/docs/reference/yolo/data/converter.md index 7f8833aa9..9ec32b862 100644 --- a/docs/reference/yolo/data/converter.md +++ b/docs/reference/yolo/data/converter.md @@ -31,4 +31,4 @@ keywords: Ultralytics, YOLO, converter, COCO91, COCO80, rle2polygon, merge_multi # delete_dsstore --- :::ultralytics.yolo.data.converter.delete_dsstore -

\ No newline at end of file +

diff --git a/docs/reference/yolo/data/dataloaders/stream_loaders.md b/docs/reference/yolo/data/dataloaders/stream_loaders.md index 536aa8d45..ce7e657e1 100644 --- a/docs/reference/yolo/data/dataloaders/stream_loaders.md +++ b/docs/reference/yolo/data/dataloaders/stream_loaders.md @@ -41,4 +41,4 @@ keywords: Ultralytics YOLO, data loaders, stream load images, screenshots, tenso # get_best_youtube_url --- :::ultralytics.yolo.data.dataloaders.stream_loaders.get_best_youtube_url -

\ No newline at end of file +

diff --git a/docs/reference/yolo/data/dataloaders/v5augmentations.md b/docs/reference/yolo/data/dataloaders/v5augmentations.md index aa5f3f710..935768f43 100644 --- a/docs/reference/yolo/data/dataloaders/v5augmentations.md +++ b/docs/reference/yolo/data/dataloaders/v5augmentations.md @@ -86,4 +86,4 @@ keywords: YOLO, object detection, data loaders, V5 augmentations, CenterCrop, no # classify_transforms --- :::ultralytics.yolo.data.dataloaders.v5augmentations.classify_transforms -

\ No newline at end of file +

diff --git a/docs/reference/yolo/data/dataloaders/v5loader.md b/docs/reference/yolo/data/dataloaders/v5loader.md index 20161f8b7..a4c1a0480 100644 --- a/docs/reference/yolo/data/dataloaders/v5loader.md +++ b/docs/reference/yolo/data/dataloaders/v5loader.md @@ -91,4 +91,4 @@ keywords: YOLO, data loader, image classification, object detection, Ultralytics # create_classification_dataloader --- :::ultralytics.yolo.data.dataloaders.v5loader.create_classification_dataloader -

\ No newline at end of file +

diff --git a/docs/reference/yolo/data/dataset.md b/docs/reference/yolo/data/dataset.md index f5bd9a101..225dfc7a1 100644 --- a/docs/reference/yolo/data/dataset.md +++ b/docs/reference/yolo/data/dataset.md @@ -16,4 +16,4 @@ keywords: YOLODataset, SemanticDataset, Ultralytics YOLO Docs, Object Detection, # SemanticDataset --- :::ultralytics.yolo.data.dataset.SemanticDataset -

\ No newline at end of file +

diff --git a/docs/reference/yolo/data/dataset_wrappers.md b/docs/reference/yolo/data/dataset_wrappers.md index 49a24af65..656db2c2e 100644 --- a/docs/reference/yolo/data/dataset_wrappers.md +++ b/docs/reference/yolo/data/dataset_wrappers.md @@ -6,4 +6,4 @@ keywords: Ultralytics YOLO, MixAndRectDataset, dataset wrapper, image-level anno # MixAndRectDataset --- :::ultralytics.yolo.data.dataset_wrappers.MixAndRectDataset -

\ No newline at end of file +

diff --git a/docs/reference/yolo/data/utils.md b/docs/reference/yolo/data/utils.md index 19bd739a5..1f09d581f 100644 --- a/docs/reference/yolo/data/utils.md +++ b/docs/reference/yolo/data/utils.md @@ -66,4 +66,4 @@ keywords: YOLOv4, Object Detection, Computer Vision, Deep Learning, Convolutiona # zip_directory --- :::ultralytics.yolo.data.utils.zip_directory -

\ No newline at end of file +

diff --git a/docs/reference/yolo/engine/exporter.md b/docs/reference/yolo/engine/exporter.md index aef271b5c..35b94b581 100644 --- a/docs/reference/yolo/engine/exporter.md +++ b/docs/reference/yolo/engine/exporter.md @@ -31,4 +31,4 @@ keywords: Ultralytics, YOLO, exporter, iOS detect model, gd_outputs, export # export --- :::ultralytics.yolo.engine.exporter.export -

\ No newline at end of file +

diff --git a/docs/reference/yolo/engine/model.md b/docs/reference/yolo/engine/model.md index be3633992..e36a03ecb 100644 --- a/docs/reference/yolo/engine/model.md +++ b/docs/reference/yolo/engine/model.md @@ -6,4 +6,4 @@ keywords: YOLO, object detection, model, architecture, usage, customization, Ult # YOLO --- :::ultralytics.yolo.engine.model.YOLO -

\ No newline at end of file +

diff --git a/docs/reference/yolo/engine/predictor.md b/docs/reference/yolo/engine/predictor.md index ec17842f5..86af0d316 100644 --- a/docs/reference/yolo/engine/predictor.md +++ b/docs/reference/yolo/engine/predictor.md @@ -6,4 +6,4 @@ keywords: Ultralytics, YOLO, BasePredictor, Object Detection, Computer Vision, F # BasePredictor --- :::ultralytics.yolo.engine.predictor.BasePredictor -

\ No newline at end of file +

diff --git a/docs/reference/yolo/engine/results.md b/docs/reference/yolo/engine/results.md index 504864cb1..3cf4f22d5 100644 --- a/docs/reference/yolo/engine/results.md +++ b/docs/reference/yolo/engine/results.md @@ -31,4 +31,4 @@ keywords: YOLO, Engine, Results, Masks, Probs, Ultralytics # Probs --- :::ultralytics.yolo.engine.results.Probs -

\ No newline at end of file +

diff --git a/docs/reference/yolo/engine/trainer.md b/docs/reference/yolo/engine/trainer.md index fc51c24bc..1d1419335 100644 --- a/docs/reference/yolo/engine/trainer.md +++ b/docs/reference/yolo/engine/trainer.md @@ -6,4 +6,4 @@ keywords: Ultralytics YOLO, BaseTrainer, object detection models, training guide # BaseTrainer --- :::ultralytics.yolo.engine.trainer.BaseTrainer -

\ No newline at end of file +

diff --git a/docs/reference/yolo/engine/validator.md b/docs/reference/yolo/engine/validator.md index d99b06255..6c0926919 100644 --- a/docs/reference/yolo/engine/validator.md +++ b/docs/reference/yolo/engine/validator.md @@ -6,4 +6,4 @@ keywords: Ultralytics, YOLO, BaseValidator, models, validation, object detection # BaseValidator --- :::ultralytics.yolo.engine.validator.BaseValidator -

\ No newline at end of file +

diff --git a/docs/reference/yolo/nas/model.md b/docs/reference/yolo/nas/model.md index c5fe25846..bca0b307b 100644 --- a/docs/reference/yolo/nas/model.md +++ b/docs/reference/yolo/nas/model.md @@ -6,4 +6,4 @@ keywords: Ultralytics YOLO, object detection, NAS, Neural Architecture Search, m # NAS --- :::ultralytics.yolo.nas.model.NAS -

\ No newline at end of file +

diff --git a/docs/reference/yolo/nas/predict.md b/docs/reference/yolo/nas/predict.md index 0b8a62d1f..d5ef4a37f 100644 --- a/docs/reference/yolo/nas/predict.md +++ b/docs/reference/yolo/nas/predict.md @@ -6,4 +6,4 @@ keywords: Ultralytics YOLO, NASPredictor, neural architecture search, efficient # NASPredictor --- :::ultralytics.yolo.nas.predict.NASPredictor -

\ No newline at end of file +

diff --git a/docs/reference/yolo/nas/val.md b/docs/reference/yolo/nas/val.md index 6f849a471..f653743ba 100644 --- a/docs/reference/yolo/nas/val.md +++ b/docs/reference/yolo/nas/val.md @@ -6,4 +6,4 @@ keywords: NASValidator, YOLO, neural architecture search, validation, performanc # NASValidator --- :::ultralytics.yolo.nas.val.NASValidator -

\ No newline at end of file +

diff --git a/docs/reference/yolo/utils/autobatch.md b/docs/reference/yolo/utils/autobatch.md index dc7c0a8b8..caf693b12 100644 --- a/docs/reference/yolo/utils/autobatch.md +++ b/docs/reference/yolo/utils/autobatch.md @@ -11,4 +11,4 @@ keywords: YOLOv5, batch size, training, Ultralytics Autobatch, object detection, # autobatch --- :::ultralytics.yolo.utils.autobatch.autobatch -

\ No newline at end of file +

diff --git a/docs/reference/yolo/utils/benchmarks.md b/docs/reference/yolo/utils/benchmarks.md index 39112eac2..f674a6a5c 100644 --- a/docs/reference/yolo/utils/benchmarks.md +++ b/docs/reference/yolo/utils/benchmarks.md @@ -11,4 +11,4 @@ keywords: Ultralytics YOLO, ProfileModels, benchmark, model inference, detection # benchmark --- :::ultralytics.yolo.utils.benchmarks.benchmark -

\ No newline at end of file +

diff --git a/docs/reference/yolo/utils/callbacks/base.md b/docs/reference/yolo/utils/callbacks/base.md index d82f0fd28..bf54d92a6 100644 --- a/docs/reference/yolo/utils/callbacks/base.md +++ b/docs/reference/yolo/utils/callbacks/base.md @@ -136,4 +136,4 @@ keywords: YOLO, Ultralytics, callbacks, object detection, training, inference # add_integration_callbacks --- :::ultralytics.yolo.utils.callbacks.base.add_integration_callbacks -

\ No newline at end of file +

diff --git a/docs/reference/yolo/utils/callbacks/clearml.md b/docs/reference/yolo/utils/callbacks/clearml.md index 7dc01a38d..a5c14b231 100644 --- a/docs/reference/yolo/utils/callbacks/clearml.md +++ b/docs/reference/yolo/utils/callbacks/clearml.md @@ -36,4 +36,4 @@ keywords: Ultralytics YOLO, callbacks, log plots, epoch monitoring, training end # on_train_end --- :::ultralytics.yolo.utils.callbacks.clearml.on_train_end -

\ No newline at end of file +

diff --git a/docs/reference/yolo/utils/callbacks/comet.md b/docs/reference/yolo/utils/callbacks/comet.md index 2e1bffe83..f9ac5fa56 100644 --- a/docs/reference/yolo/utils/callbacks/comet.md +++ b/docs/reference/yolo/utils/callbacks/comet.md @@ -121,4 +121,4 @@ keywords: Ultralytics, YOLO, callbacks, Comet ML, log images, log predictions, l # on_train_end --- :::ultralytics.yolo.utils.callbacks.comet.on_train_end -

\ No newline at end of file +

diff --git a/docs/reference/yolo/utils/callbacks/dvc.md b/docs/reference/yolo/utils/callbacks/dvc.md index 1ca463697..16045deb2 100644 --- a/docs/reference/yolo/utils/callbacks/dvc.md +++ b/docs/reference/yolo/utils/callbacks/dvc.md @@ -51,4 +51,4 @@ keywords: Ultralytics, YOLO, Utils, DVC, Callbacks, images, plots, confusion mat # on_train_end --- :::ultralytics.yolo.utils.callbacks.dvc.on_train_end -

\ No newline at end of file +

diff --git a/docs/reference/yolo/utils/callbacks/hub.md b/docs/reference/yolo/utils/callbacks/hub.md index 7337c86c5..0a37b35f5 100644 --- a/docs/reference/yolo/utils/callbacks/hub.md +++ b/docs/reference/yolo/utils/callbacks/hub.md @@ -41,4 +41,4 @@ keywords: Ultralytics, YOLO, callbacks, on_pretrain_routine_end, on_fit_epoch_en # on_export_start --- :::ultralytics.yolo.utils.callbacks.hub.on_export_start -

\ No newline at end of file +

diff --git a/docs/reference/yolo/utils/callbacks/mlflow.md b/docs/reference/yolo/utils/callbacks/mlflow.md index b67089049..5679dce9e 100644 --- a/docs/reference/yolo/utils/callbacks/mlflow.md +++ b/docs/reference/yolo/utils/callbacks/mlflow.md @@ -16,4 +16,4 @@ keywords: Ultralytics, YOLO, Utils, MLflow, callbacks, on_pretrain_routine_end, # on_train_end --- :::ultralytics.yolo.utils.callbacks.mlflow.on_train_end -

\ No newline at end of file +

diff --git a/docs/reference/yolo/utils/callbacks/neptune.md b/docs/reference/yolo/utils/callbacks/neptune.md index 195c9beef..1e4fa1a83 100644 --- a/docs/reference/yolo/utils/callbacks/neptune.md +++ b/docs/reference/yolo/utils/callbacks/neptune.md @@ -41,4 +41,4 @@ keywords: Ultralytics, YOLO, Neptune, Callbacks, log scalars, log images, log pl # on_train_end --- :::ultralytics.yolo.utils.callbacks.neptune.on_train_end -

\ No newline at end of file +

diff --git a/docs/reference/yolo/utils/callbacks/raytune.md b/docs/reference/yolo/utils/callbacks/raytune.md index fa1267d35..53fdfe348 100644 --- a/docs/reference/yolo/utils/callbacks/raytune.md +++ b/docs/reference/yolo/utils/callbacks/raytune.md @@ -6,4 +6,4 @@ keywords: on_fit_epoch_end, Ultralytics YOLO, callback function, training, model # on_fit_epoch_end --- :::ultralytics.yolo.utils.callbacks.raytune.on_fit_epoch_end -

\ No newline at end of file +

diff --git a/docs/reference/yolo/utils/callbacks/tensorboard.md b/docs/reference/yolo/utils/callbacks/tensorboard.md index bf0f4c42c..7c43cb0f3 100644 --- a/docs/reference/yolo/utils/callbacks/tensorboard.md +++ b/docs/reference/yolo/utils/callbacks/tensorboard.md @@ -21,4 +21,4 @@ keywords: TensorBoard callbacks, YOLO training, ultralytics YOLO # on_fit_epoch_end --- :::ultralytics.yolo.utils.callbacks.tensorboard.on_fit_epoch_end -

\ No newline at end of file +

diff --git a/docs/reference/yolo/utils/callbacks/wb.md b/docs/reference/yolo/utils/callbacks/wb.md index 03045e295..f8476a0b3 100644 --- a/docs/reference/yolo/utils/callbacks/wb.md +++ b/docs/reference/yolo/utils/callbacks/wb.md @@ -26,4 +26,4 @@ keywords: Ultralytics, YOLO, callbacks, weights, biases, training # on_train_end --- :::ultralytics.yolo.utils.callbacks.wb.on_train_end -

\ No newline at end of file +

diff --git a/docs/reference/yolo/utils/checks.md b/docs/reference/yolo/utils/checks.md index 4995371a5..ad31e3ce0 100644 --- a/docs/reference/yolo/utils/checks.md +++ b/docs/reference/yolo/utils/checks.md @@ -86,4 +86,4 @@ keywords: YOLO, Ultralytics, Utils, Checks, image sizing, version updates, font # print_args --- :::ultralytics.yolo.utils.checks.print_args -

\ No newline at end of file +

diff --git a/docs/reference/yolo/utils/dist.md b/docs/reference/yolo/utils/dist.md index c5505446e..8b06afefd 100644 --- a/docs/reference/yolo/utils/dist.md +++ b/docs/reference/yolo/utils/dist.md @@ -21,4 +21,4 @@ keywords: ultralytics, YOLO, utils, dist, distributed deep learning, DDP file, D # ddp_cleanup --- :::ultralytics.yolo.utils.dist.ddp_cleanup -

\ No newline at end of file +

diff --git a/docs/reference/yolo/utils/downloads.md b/docs/reference/yolo/utils/downloads.md index 5206e02c9..a772231a3 100644 --- a/docs/reference/yolo/utils/downloads.md +++ b/docs/reference/yolo/utils/downloads.md @@ -31,4 +31,4 @@ keywords: Ultralytics YOLO, downloads, trained models, datasets, weights, deep l # download --- :::ultralytics.yolo.utils.downloads.download -

\ No newline at end of file +

diff --git a/docs/reference/yolo/utils/errors.md b/docs/reference/yolo/utils/errors.md index a498db258..8233d18ad 100644 --- a/docs/reference/yolo/utils/errors.md +++ b/docs/reference/yolo/utils/errors.md @@ -6,4 +6,4 @@ keywords: HUBModelError, Ultralytics YOLO, YOLO Documentation, Object detection # HUBModelError --- :::ultralytics.yolo.utils.errors.HUBModelError -

\ No newline at end of file +

diff --git a/docs/reference/yolo/utils/files.md b/docs/reference/yolo/utils/files.md index 4ca39c721..9dfe1ac7a 100644 --- a/docs/reference/yolo/utils/files.md +++ b/docs/reference/yolo/utils/files.md @@ -36,4 +36,4 @@ keywords: YOLO, object detection, file utils, file age, file size, working direc # make_dirs --- :::ultralytics.yolo.utils.files.make_dirs -

\ No newline at end of file +

diff --git a/docs/reference/yolo/utils/instance.md b/docs/reference/yolo/utils/instance.md index 1b32a8088..695adc337 100644 --- a/docs/reference/yolo/utils/instance.md +++ b/docs/reference/yolo/utils/instance.md @@ -16,4 +16,4 @@ keywords: Ultralytics, YOLO, Bboxes, _ntuple, object detection, instance segment # _ntuple --- :::ultralytics.yolo.utils.instance._ntuple -

\ No newline at end of file +

diff --git a/docs/reference/yolo/utils/loss.md b/docs/reference/yolo/utils/loss.md index ad4aa6882..38c4f0a0e 100644 --- a/docs/reference/yolo/utils/loss.md +++ b/docs/reference/yolo/utils/loss.md @@ -36,4 +36,4 @@ keywords: Ultralytics, YOLO, loss functions, object detection, keypoint detectio # v8ClassificationLoss --- :::ultralytics.yolo.utils.loss.v8ClassificationLoss -

\ No newline at end of file +

diff --git a/docs/reference/yolo/utils/metrics.md b/docs/reference/yolo/utils/metrics.md index 4cb1158f1..7f1480350 100644 --- a/docs/reference/yolo/utils/metrics.md +++ b/docs/reference/yolo/utils/metrics.md @@ -96,4 +96,4 @@ keywords: YOLOv5, metrics, losses, confusion matrix, detection metrics, pose met # ap_per_class --- :::ultralytics.yolo.utils.metrics.ap_per_class -

\ No newline at end of file +

diff --git a/docs/reference/yolo/utils/ops.md b/docs/reference/yolo/utils/ops.md index 0a8aa3565..45e3d6c95 100644 --- a/docs/reference/yolo/utils/ops.md +++ b/docs/reference/yolo/utils/ops.md @@ -136,4 +136,4 @@ keywords: Ultralytics, YOLO, Utils Ops, Functions, coco80_to_coco91_class, scale # clean_str --- :::ultralytics.yolo.utils.ops.clean_str -

\ No newline at end of file +

diff --git a/docs/reference/yolo/utils/patches.md b/docs/reference/yolo/utils/patches.md new file mode 100644 index 000000000..46e66000b --- /dev/null +++ b/docs/reference/yolo/utils/patches.md @@ -0,0 +1,24 @@ +--- +description: Learn how to use the Ultralytics YOLO Utils package's imread and imshow functions. These functions are used for reading and writing image files. Try out our TorchSave feature today. +keywords: imread, imshow, ultralytics, YOLO, image files, torchsave +--- + +# imread +--- +:::ultralytics.yolo.utils.patches.imread +

+ +# imwrite +--- +:::ultralytics.yolo.utils.patches.imwrite +

+ +# imshow +--- +:::ultralytics.yolo.utils.patches.imshow +

+ +# torch_save +--- +:::ultralytics.yolo.utils.patches.torch_save +

diff --git a/docs/reference/yolo/utils/plotting.md b/docs/reference/yolo/utils/plotting.md index f402f4814..15b4534bf 100644 --- a/docs/reference/yolo/utils/plotting.md +++ b/docs/reference/yolo/utils/plotting.md @@ -41,4 +41,4 @@ keywords: YOLO, object detection, plotting, visualization, annotator, save one b # feature_visualization --- :::ultralytics.yolo.utils.plotting.feature_visualization -

\ No newline at end of file +

diff --git a/docs/reference/yolo/utils/tal.md b/docs/reference/yolo/utils/tal.md index 1f3093220..3238085e4 100644 --- a/docs/reference/yolo/utils/tal.md +++ b/docs/reference/yolo/utils/tal.md @@ -31,4 +31,4 @@ keywords: Ultrayltics, YOLO, select_candidates_in_gts, make_anchor, bbox2dist, o # bbox2dist --- :::ultralytics.yolo.utils.tal.bbox2dist -

\ No newline at end of file +

diff --git a/docs/reference/yolo/utils/torch_utils.md b/docs/reference/yolo/utils/torch_utils.md index dbdb78679..050091d04 100644 --- a/docs/reference/yolo/utils/torch_utils.md +++ b/docs/reference/yolo/utils/torch_utils.md @@ -131,4 +131,4 @@ keywords: Ultralytics YOLO, Torch, Utils, Pytorch, Object Detection # profile --- :::ultralytics.yolo.utils.torch_utils.profile -

\ No newline at end of file +

diff --git a/docs/reference/yolo/v8/classify/predict.md b/docs/reference/yolo/v8/classify/predict.md index a99f833ea..a141da7fe 100644 --- a/docs/reference/yolo/v8/classify/predict.md +++ b/docs/reference/yolo/v8/classify/predict.md @@ -11,4 +11,4 @@ keywords: Ultralytics, YOLO, v8, Classify Predictor, object detection, classific # predict --- :::ultralytics.yolo.v8.classify.predict.predict -

\ No newline at end of file +

diff --git a/docs/reference/yolo/v8/classify/train.md b/docs/reference/yolo/v8/classify/train.md index 076b27749..7ae112143 100644 --- a/docs/reference/yolo/v8/classify/train.md +++ b/docs/reference/yolo/v8/classify/train.md @@ -11,4 +11,4 @@ keywords: Ultralytics, YOLOv8, object detection, classification, training, API # train --- :::ultralytics.yolo.v8.classify.train.train -

\ No newline at end of file +

diff --git a/docs/reference/yolo/v8/classify/val.md b/docs/reference/yolo/v8/classify/val.md index fda08e21e..2223a90bd 100644 --- a/docs/reference/yolo/v8/classify/val.md +++ b/docs/reference/yolo/v8/classify/val.md @@ -11,4 +11,4 @@ keywords: ClassificationValidator, Ultralytics YOLO, Validation, Data Science, D # val --- :::ultralytics.yolo.v8.classify.val.val -

\ No newline at end of file +

diff --git a/docs/reference/yolo/v8/detect/predict.md b/docs/reference/yolo/v8/detect/predict.md index de49aa0f8..1efe30e93 100644 --- a/docs/reference/yolo/v8/detect/predict.md +++ b/docs/reference/yolo/v8/detect/predict.md @@ -11,4 +11,4 @@ keywords: detectionpredictor, ultralytics yolo, object detection, neural network # predict --- :::ultralytics.yolo.v8.detect.predict.predict -

\ No newline at end of file +

diff --git a/docs/reference/yolo/v8/detect/train.md b/docs/reference/yolo/v8/detect/train.md index 9ed57ad87..c88b98d3e 100644 --- a/docs/reference/yolo/v8/detect/train.md +++ b/docs/reference/yolo/v8/detect/train.md @@ -11,4 +11,4 @@ keywords: DetectionTrainer, Ultralytics YOLO, custom object detection, train mod # train --- :::ultralytics.yolo.v8.detect.train.train -

\ No newline at end of file +

diff --git a/docs/reference/yolo/v8/detect/val.md b/docs/reference/yolo/v8/detect/val.md index dec0259df..582df48d0 100644 --- a/docs/reference/yolo/v8/detect/val.md +++ b/docs/reference/yolo/v8/detect/val.md @@ -11,4 +11,4 @@ keywords: detection, validator, YOLOv5, object detection, model improvement, Ult # val --- :::ultralytics.yolo.v8.detect.val.val -

\ No newline at end of file +

diff --git a/docs/reference/yolo/v8/pose/predict.md b/docs/reference/yolo/v8/pose/predict.md index 6f333cf75..d25715075 100644 --- a/docs/reference/yolo/v8/pose/predict.md +++ b/docs/reference/yolo/v8/pose/predict.md @@ -11,4 +11,4 @@ keywords: Ultralytics, YOLO, v8, documentation, PosePredictor, pose prediction, # predict --- :::ultralytics.yolo.v8.pose.predict.predict -

\ No newline at end of file +

diff --git a/docs/reference/yolo/v8/pose/train.md b/docs/reference/yolo/v8/pose/train.md index ede822f22..35652f815 100644 --- a/docs/reference/yolo/v8/pose/train.md +++ b/docs/reference/yolo/v8/pose/train.md @@ -11,4 +11,4 @@ keywords: PoseTrainer, human pose models, deep learning, computer vision, Ultral # train --- :::ultralytics.yolo.v8.pose.train.train -

\ No newline at end of file +

diff --git a/docs/reference/yolo/v8/pose/val.md b/docs/reference/yolo/v8/pose/val.md index af5f5873c..26e13d9a1 100644 --- a/docs/reference/yolo/v8/pose/val.md +++ b/docs/reference/yolo/v8/pose/val.md @@ -11,4 +11,4 @@ keywords: PoseValidator, Ultralytics YOLO, object detection, pose analysis, vali # val --- :::ultralytics.yolo.v8.pose.val.val -

\ No newline at end of file +

diff --git a/docs/reference/yolo/v8/segment/predict.md b/docs/reference/yolo/v8/segment/predict.md index 30afdbd0b..8319f0ccd 100644 --- a/docs/reference/yolo/v8/segment/predict.md +++ b/docs/reference/yolo/v8/segment/predict.md @@ -11,4 +11,4 @@ keywords: Ultralytics YOLO, SegmentationPredictor, object detection, segmentatio # predict --- :::ultralytics.yolo.v8.segment.predict.predict -

\ No newline at end of file +

diff --git a/docs/reference/yolo/v8/segment/train.md b/docs/reference/yolo/v8/segment/train.md index 7bf27a0b8..6f553c944 100644 --- a/docs/reference/yolo/v8/segment/train.md +++ b/docs/reference/yolo/v8/segment/train.md @@ -11,4 +11,4 @@ keywords: SegmentationTrainer, Ultralytics YOLO, object detection, segmentation, # train --- :::ultralytics.yolo.v8.segment.train.train -

\ No newline at end of file +

diff --git a/docs/reference/yolo/v8/segment/val.md b/docs/reference/yolo/v8/segment/val.md index 382660d2c..c548145b7 100644 --- a/docs/reference/yolo/v8/segment/val.md +++ b/docs/reference/yolo/v8/segment/val.md @@ -11,4 +11,4 @@ keywords: SegmentationValidator, YOLOv8, Ultralytics Docs, segmentation model, v # val --- :::ultralytics.yolo.v8.segment.val.val -

\ No newline at end of file +