HongChuang/ultralytics-ascend
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

Engine Model and Results Docs improvements (#14564)

Browse source 
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
Download patch file Download diff file Expand all files Collapse all files

54
docs/en/reference/utils/callbacks/base.md
View file

@ -9,111 +9,111 @@ keywords: Ultralytics, base callbacks, training, validation, prediction, model e
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 🙏!
<br><br>
<br>
## ::: ultralytics.utils.callbacks.base.on_pretrain_routine_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_pretrain_routine_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_train_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_train_epoch_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_train_batch_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.optimizer_step
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_before_zero_grad
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_train_batch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_train_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_fit_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_model_save
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_train_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_params_update
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.teardown
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_val_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_val_batch_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_val_batch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_val_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_predict_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_predict_batch_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_predict_batch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_predict_postprocess_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_predict_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_export_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_export_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.get_default_callbacks
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.add_integration_callbacks

14
docs/en/reference/utils/callbacks/clearml.md
View file

@ -9,31 +9,31 @@ keywords: Ultralytics, YOLO, ClearML, integration, callbacks, pretraining, train
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 🙏!
<br><br>
<br>
## ::: ultralytics.utils.callbacks.clearml._log_debug_samples
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.clearml._log_plot
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.clearml.on_pretrain_routine_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.clearml.on_train_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.clearml.on_fit_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.clearml.on_val_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.clearml.on_train_end

48
docs/en/reference/utils/callbacks/comet.md
View file

@ -9,99 +9,99 @@ keywords: Ultralytics, YOLO, Comet, callbacks, logging, machine learning, monito
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 🙏!
<br><br>
<br>
## ::: ultralytics.utils.callbacks.comet._get_comet_mode
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._get_comet_model_name
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._get_eval_batch_logging_interval
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._get_max_image_predictions_to_log
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._scale_confidence_score
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._should_log_confusion_matrix
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._should_log_image_predictions
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._get_experiment_type
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._create_experiment
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._fetch_trainer_metadata
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._scale_bounding_box_to_original_image_shape
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._format_ground_truth_annotations_for_detection
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._format_prediction_annotations_for_detection
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._fetch_annotations
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._create_prediction_metadata_map
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._log_confusion_matrix
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._log_images
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._log_image_predictions
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._log_plots
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._log_model
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet.on_pretrain_routine_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet.on_train_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet.on_fit_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet.on_train_end

18
docs/en/reference/utils/callbacks/dvc.md
View file

@ -9,39 +9,39 @@ keywords: Ultralytics, DVC, DVCLive, machine learning, logging, training, callba
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 🙏!
<br><br>
<br>
## ::: ultralytics.utils.callbacks.dvc._log_images
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc._log_plots
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc._log_confusion_matrix
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc.on_train_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc.on_train_epoch_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc.on_fit_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc.on_train_end

18
docs/en/reference/utils/callbacks/hub.md
View file

@ -9,39 +9,39 @@ keywords: Ultralytics, callbacks, pretrain, model save, train start, train end,
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 🙏!
<br><br>
<br>
## ::: ultralytics.utils.callbacks.hub.on_pretrain_routine_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_pretrain_routine_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_fit_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_model_save
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_train_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_train_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_val_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_predict_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_export_start

10
docs/en/reference/utils/callbacks/mlflow.md
View file

@ -9,23 +9,23 @@ keywords: MLflow, Ultralytics YOLO, logging, metrics, parameters, model artifact
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 🙏!
<br><br>
<br>
## ::: ultralytics.utils.callbacks.mlflow.sanitize_dict
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.mlflow.on_pretrain_routine_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.mlflow.on_train_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.mlflow.on_fit_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.mlflow.on_train_end

16
docs/en/reference/utils/callbacks/neptune.md
View file

@ -9,35 +9,35 @@ keywords: Ultralytics, NeptuneAI, YOLO, experiment logging, machine learning, AI
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 🙏!
<br><br>
<br>
## ::: ultralytics.utils.callbacks.neptune._log_scalars
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune._log_images
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune._log_plot
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune.on_pretrain_routine_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune.on_train_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune.on_fit_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune.on_val_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune.on_train_end

2
docs/en/reference/utils/callbacks/raytune.md
View file

@ -9,7 +9,7 @@ keywords: Ultralytics, Ray Tune, hyperparameter tuning, YOLO, machine learning,
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 🙏!
<br><br>
<br>
## ::: ultralytics.utils.callbacks.raytune.on_fit_epoch_end

12
docs/en/reference/utils/callbacks/tensorboard.md
View file

@ -9,27 +9,27 @@ keywords: Ultralytics, TensorBoard, callbacks, machine learning, training visual
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 🙏!
<br><br>
<br>
## ::: ultralytics.utils.callbacks.tensorboard._log_scalars
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.tensorboard._log_tensorboard_graph
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.tensorboard.on_pretrain_routine_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.tensorboard.on_train_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.tensorboard.on_train_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.tensorboard.on_fit_epoch_end

14
docs/en/reference/utils/callbacks/wb.md
View file

@ -9,31 +9,31 @@ keywords: Ultralytics, YOLO, WandB, callbacks, logging, metrics, visualizations,
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 🙏!
<br><br>
<br>
## ::: ultralytics.utils.callbacks.wb._custom_table
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.wb._plot_curve
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.wb._log_plots
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.wb.on_pretrain_routine_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.wb.on_fit_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.wb.on_train_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.wb.on_train_end