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

Update docs predict, buttons, reference (#6585)

Browse source 
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
This commit is contained in:
Glenn Jocher 2023-11-25 17:59:01 +01:00 • committed by GitHub
parent a1ccdb00ed
commit e361194d7f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
141 changed files with 1044 additions and 828 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -9,110 +9,112 @@ keywords: Ultralytics, Callbacks, On-train, On-validation, On-pretrain, On-predi
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>
## ::: ultralytics.utils.callbacks.base.on_pretrain_routine_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_pretrain_routine_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_train_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_train_epoch_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_train_batch_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.optimizer_step
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_before_zero_grad
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_train_batch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_train_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_fit_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_model_save
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_train_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_params_update
<br><br>
---
## ::: ultralytics.utils.callbacks.base.teardown
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_val_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_val_batch_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_val_batch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_val_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_predict_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_predict_batch_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_predict_batch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_predict_postprocess_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_predict_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_export_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_export_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.get_default_callbacks
<br><br>
---
## ::: ultralytics.utils.callbacks.base.add_integration_callbacks
<br><br>

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

@ -9,30 +9,32 @@ keywords: Ultralytics, clearML, callbacks, pretrain routine start, validation en
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>
## ::: ultralytics.utils.callbacks.clearml._log_debug_samples
<br><br>
---
## ::: ultralytics.utils.callbacks.clearml._log_plot
<br><br>
---
## ::: ultralytics.utils.callbacks.clearml.on_pretrain_routine_start
<br><br>
---
## ::: ultralytics.utils.callbacks.clearml.on_train_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.clearml.on_fit_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.clearml.on_val_end
<br><br>
---
## ::: ultralytics.utils.callbacks.clearml.on_train_end
<br><br>

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

@ -9,98 +9,100 @@ keywords: Ultralytics, Comet Callbacks, Training optimisation, Logging, Experime
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>
## ::: ultralytics.utils.callbacks.comet._get_comet_mode
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._get_comet_model_name
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._get_eval_batch_logging_interval
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._get_max_image_predictions_to_log
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._scale_confidence_score
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._should_log_confusion_matrix
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._should_log_image_predictions
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._get_experiment_type
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._create_experiment
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._fetch_trainer_metadata
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._scale_bounding_box_to_original_image_shape
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._format_ground_truth_annotations_for_detection
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._format_prediction_annotations_for_detection
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._fetch_annotations
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._create_prediction_metadata_map
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._log_confusion_matrix
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._log_images
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._log_image_predictions
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._log_plots
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._log_model
<br><br>
---
## ::: ultralytics.utils.callbacks.comet.on_pretrain_routine_start
<br><br>
---
## ::: ultralytics.utils.callbacks.comet.on_train_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.comet.on_fit_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.comet.on_train_end
<br><br>

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

@ -9,38 +9,40 @@ keywords: Ultralytics, YOLO, callbacks, logger, training, pretraining, machine l
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>
## ::: ultralytics.utils.callbacks.dvc._log_images
<br><br>
---
## ::: ultralytics.utils.callbacks.dvc._log_plots
<br><br>
---
## ::: ultralytics.utils.callbacks.dvc._log_confusion_matrix
<br><br>
---
## ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_start
<br><br>
---
## ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_end
<br><br>
---
## ::: ultralytics.utils.callbacks.dvc.on_train_start
<br><br>
---
## ::: ultralytics.utils.callbacks.dvc.on_train_epoch_start
<br><br>
---
## ::: ultralytics.utils.callbacks.dvc.on_fit_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.dvc.on_train_end
<br><br>

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

@ -9,34 +9,36 @@ keywords: Ultralytics, callbacks, on_pretrain_routine_end, on_model_save, on_tra
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>
## ::: ultralytics.utils.callbacks.hub.on_pretrain_routine_end
<br><br>
---
## ::: ultralytics.utils.callbacks.hub.on_fit_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.hub.on_model_save
<br><br>
---
## ::: ultralytics.utils.callbacks.hub.on_train_end
<br><br>
---
## ::: ultralytics.utils.callbacks.hub.on_train_start
<br><br>
---
## ::: ultralytics.utils.callbacks.hub.on_val_start
<br><br>
---
## ::: ultralytics.utils.callbacks.hub.on_predict_start
<br><br>
---
## ::: ultralytics.utils.callbacks.hub.on_export_start
<br><br>

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

@ -9,14 +9,16 @@ keywords: Ultralytics, MLflow, Callbacks, on_pretrain_routine_end, on_train_end,
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>
## ::: ultralytics.utils.callbacks.mlflow.on_pretrain_routine_end
<br><br>
---
## ::: ultralytics.utils.callbacks.mlflow.on_fit_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.mlflow.on_train_end
<br><br>

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

@ -9,34 +9,36 @@ keywords: Ultralytics, Neptune callbacks, on_train_epoch_end, on_val_end, _log_p
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>
## ::: ultralytics.utils.callbacks.neptune._log_scalars
<br><br>
---
## ::: ultralytics.utils.callbacks.neptune._log_images
<br><br>
---
## ::: ultralytics.utils.callbacks.neptune._log_plot
<br><br>
---
## ::: ultralytics.utils.callbacks.neptune.on_pretrain_routine_start
<br><br>
---
## ::: ultralytics.utils.callbacks.neptune.on_train_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.neptune.on_fit_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.neptune.on_val_end
<br><br>
---
## ::: ultralytics.utils.callbacks.neptune.on_train_end
<br><br>

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

@ -9,6 +9,8 @@ keywords: Ultralytics, YOLO, on_fit_epoch_end, callbacks, documentation, deep le
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 🙏!
---
## ::: ultralytics.utils.callbacks.raytune.on_fit_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.raytune.on_fit_epoch_end
<br><br>

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

@ -9,26 +9,28 @@ keywords: Ultralytics, YOLO, documentation, callback utilities, log_scalars, on_
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>
## ::: ultralytics.utils.callbacks.tensorboard._log_scalars
<br><br>
---
## ::: ultralytics.utils.callbacks.tensorboard._log_tensorboard_graph
<br><br>
---
## ::: ultralytics.utils.callbacks.tensorboard.on_pretrain_routine_start
<br><br>
---
## ::: ultralytics.utils.callbacks.tensorboard.on_train_start
<br><br>
---
## ::: ultralytics.utils.callbacks.tensorboard.on_batch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.tensorboard.on_fit_epoch_end
<br><br>

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

@ -9,30 +9,32 @@ keywords: Ultralytics, callbacks, _log_plots, on_fit_epoch_end, on_train_end
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>
## ::: ultralytics.utils.callbacks.wb._custom_table
<br><br>
---
## ::: ultralytics.utils.callbacks.wb._plot_curve
<br><br>
---
## ::: ultralytics.utils.callbacks.wb._log_plots
<br><br>
---
## ::: ultralytics.utils.callbacks.wb.on_pretrain_routine_start
<br><br>
---
## ::: ultralytics.utils.callbacks.wb.on_fit_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.wb.on_train_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.wb.on_train_end
<br><br>