Engine Model and Results Docs improvements (#14564)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Felipe Parodi <fparodi@pennmedicine.upenn.edu>
This commit is contained in:
Glenn Jocher 2024-07-21 20:14:49 +02:00 committed by GitHub
parent e59376b55f
commit 291883a23f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
123 changed files with 3789 additions and 1368 deletions

View file

@ -9,23 +9,23 @@ keywords: YOLOv8, export formats, ONNX, TensorRT, CoreML, machine learning model
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/exporter.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/exporter.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/engine/exporter.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.engine.exporter.Exporter
<br><br>
<br><br><hr><br>
## ::: ultralytics.engine.exporter.IOSDetectModel
<br><br>
<br><br><hr><br>
## ::: ultralytics.engine.exporter.export_formats
<br><br>
<br><br><hr><br>
## ::: ultralytics.engine.exporter.gd_outputs
<br><br>
<br><br><hr><br>
## ::: ultralytics.engine.exporter.try_export

View file

@ -9,7 +9,7 @@ keywords: YOLO model, Ultralytics, machine learning, deep learning, PyTorch mode
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/model.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/model.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/engine/model.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.engine.model.Model

View file

@ -9,7 +9,7 @@ keywords: Ultralytics, YOLO, Base Predictor, image inference, video inference, m
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/predictor.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/predictor.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/engine/predictor.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.engine.predictor.BasePredictor

View file

@ -9,31 +9,31 @@ keywords: Ultralytics, engine results, BaseTensor, Results class, Boxes, Masks,
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/results.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/results.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/engine/results.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.engine.results.BaseTensor
<br><br>
<br><br><hr><br>
## ::: ultralytics.engine.results.Results
<br><br>
<br><br><hr><br>
## ::: ultralytics.engine.results.Boxes
<br><br>
<br><br><hr><br>
## ::: ultralytics.engine.results.Masks
<br><br>
<br><br><hr><br>
## ::: ultralytics.engine.results.Keypoints
<br><br>
<br><br><hr><br>
## ::: ultralytics.engine.results.Probs
<br><br>
<br><br><hr><br>
## ::: ultralytics.engine.results.OBB

View file

@ -9,7 +9,7 @@ keywords: Ultralytics, YOLO, BaseTrainer, model training, configuration, dataset
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/trainer.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/trainer.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/engine/trainer.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.engine.trainer.BaseTrainer

View file

@ -9,7 +9,7 @@ keywords: Ultralytics, YOLO, hyperparameter tuning, machine learning, deep learn
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/tuner.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/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/engine/tuner.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.engine.tuner.Tuner

View file

@ -9,7 +9,7 @@ keywords: Ultralytics, BaseValidator, model validation, PyTorch, TensorFlow, ONN
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/validator.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/validator.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/engine/validator.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.engine.validator.BaseValidator