Add patches section and fix Docs CI (#3193)

This commit is contained in:
Glenn Jocher
2023-06-15 21:44:25 +02:00
committed by GitHub
parent 2f02d8ea53
commit 0a229bd40f
76 changed files with 99 additions and 75 deletions

View File

@ -11,4 +11,4 @@ keywords: YOLOv5, batch size, training, Ultralytics Autobatch, object detection,
# autobatch
---
:::ultralytics.yolo.utils.autobatch.autobatch
<br><br>
<br><br>

View File

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

View File

@ -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>

View File

@ -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>

View File

@ -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>

View File

@ -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>

View File

@ -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>

View File

@ -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>

View File

@ -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>

View File

@ -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>

View File

@ -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>

View File

@ -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>

View File

@ -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>

View File

@ -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>

View File

@ -31,4 +31,4 @@ keywords: Ultralytics YOLO, downloads, trained models, datasets, weights, deep l
# download
---
:::ultralytics.yolo.utils.downloads.download
<br><br>
<br><br>

View File

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

View File

@ -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>

View File

@ -16,4 +16,4 @@ keywords: Ultralytics, YOLO, Bboxes, _ntuple, object detection, instance segment
# _ntuple
---
:::ultralytics.yolo.utils.instance._ntuple
<br><br>
<br><br>

View File

@ -36,4 +36,4 @@ keywords: Ultralytics, YOLO, loss functions, object detection, keypoint detectio
# v8ClassificationLoss
---
:::ultralytics.yolo.utils.loss.v8ClassificationLoss
<br><br>
<br><br>

View File

@ -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>

View File

@ -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>

View File

@ -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>

View File

@ -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>

View File

@ -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>

View File

@ -131,4 +131,4 @@ keywords: Ultralytics YOLO, Torch, Utils, Pytorch, Object Detection
# profile
---
:::ultralytics.yolo.utils.torch_utils.profile
<br><br>
<br><br>