Add patches section and fix Docs CI (#3193)

.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: |

docs/reference/hub/auth.md

@@ -6,4 +6,4 @@ keywords: Ultralytics, ultralytics hub, api keys, authentication, collab account
 # Auth
 ---
 :::ultralytics.hub.auth.Auth
-<br><br>
+<br><br>

docs/reference/hub/session.md

@@ -6,4 +6,4 @@ keywords: YOLOv5, object detection, HUBTrainingSession, custom models, Ultralyti
 # HUBTrainingSession
 ---
 :::ultralytics.hub.session.HUBTrainingSession
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

docs/reference/nn/autoshape.md

@@ -11,4 +11,4 @@ keywords: Ultralytics, YOLO, docs, autoshape, detections, object detection, cust
 # Detections
 ---
 :::ultralytics.nn.autoshape.Detections
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

docs/reference/nn/modules/conv.md

@@ -71,4 +71,4 @@ keywords: Ultralytics, Convolutional Neural Network, Conv2, DWConv, ConvTranspos
 # autopad
 ---
 :::ultralytics.nn.modules.conv.autopad
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

docs/reference/nn/modules/transformer.md

@@ -51,4 +51,4 @@ keywords: Ultralytics, NN Modules, TransformerEncoderLayer, TransformerLayer, ML
 # DeformableTransformerDecoder
 ---
 :::ultralytics.nn.modules.transformer.DeformableTransformerDecoder
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

docs/reference/yolo/data/dataset.md

@@ -16,4 +16,4 @@ keywords: YOLODataset, SemanticDataset, Ultralytics YOLO Docs, Object Detection,
 # SemanticDataset
 ---
 :::ultralytics.yolo.data.dataset.SemanticDataset
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

docs/reference/yolo/engine/results.md

@@ -31,4 +31,4 @@ keywords: YOLO, Engine, Results, Masks, Probs, Ultralytics
 # Probs
 ---
 :::ultralytics.yolo.engine.results.Probs
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

docs/reference/yolo/engine/validator.md

@@ -6,4 +6,4 @@ keywords: Ultralytics, YOLO, BaseValidator, models, validation, object detection
 # BaseValidator
 ---
 :::ultralytics.yolo.engine.validator.BaseValidator
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

docs/reference/yolo/nas/predict.md

@@ -6,4 +6,4 @@ keywords: Ultralytics YOLO, NASPredictor, neural architecture search, efficient
 # NASPredictor
 ---
 :::ultralytics.yolo.nas.predict.NASPredictor
-<br><br>
+<br><br>

docs/reference/yolo/nas/val.md

@@ -6,4 +6,4 @@ keywords: NASValidator, YOLO, neural architecture search, validation, performanc
 # NASValidator
 ---
 :::ultralytics.yolo.nas.val.NASValidator
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

docs/reference/yolo/utils/benchmarks.md

@@ -11,4 +11,4 @@ keywords: Ultralytics YOLO, ProfileModels, benchmark, model inference, detection
 # benchmark
 ---
 :::ultralytics.yolo.utils.benchmarks.benchmark
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

docs/reference/yolo/utils/errors.md

@@ -6,4 +6,4 @@ keywords: HUBModelError, Ultralytics YOLO, YOLO Documentation, Object detection
 # HUBModelError
 ---
 :::ultralytics.yolo.utils.errors.HUBModelError
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
+<br><br>
+
+# imwrite
+---
+:::ultralytics.yolo.utils.patches.imwrite
+<br><br>
+
+# imshow
+---
+:::ultralytics.yolo.utils.patches.imshow
+<br><br>
+
+# torch_save
+---
+:::ultralytics.yolo.utils.patches.torch_save
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>

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
-<br><br>
+<br><br>