Merge branch 'main' into ray/v2.1.0

.github/pull_request_template.md

@@ -0,0 +1,16 @@
+Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.
+
+## Motivation
+
+Please describe the motivation of this PR and the goal you want to achieve through this PR.
+
+## Modification
+
+Please briefly describe what modification is made in this PR.
+
+## Checklist
+
+1. Pre-commit or other linting tools are used to fix the potential lint issues.
+2. The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
+3. If the modification has potential influence on downstream projects, this PR should be tested with downstream projects, like MMDet or MMCls.
+4. The documentation has been modified accordingly, like docstring or example tutorials.

docs/get_started.md

@@ -21,22 +21,23 @@ cd siatune
 pip install -e '.[optional]'
 ```
 
-# Hyperparamer tuning with OpenMMLab's model frameworks.
+# Hyperparameter tuning with OpenMMLab's model frameworks
 
-### Install OpenMMLab's framework.
+### Start hyperparameter tuning with existed configuration file
 ```bash
-# MMDetection Example
-mim install mmdet
+python tools/tune.py ${TUNE_CONFIG} [optional tune arguments] \
+    --trainable-args ${TASK_CONFIG} [optional task arguments]
 ```
 
-### Start hyperparameter tuning with existed configuration file.
-```bash
-python tools/tune.py ${TUNE_CONFIG} [optional tune arguments] --trainable-args [optional task arguments]
-```
+## MMDetection
 
+### Prepare datasets
+Please refer to [this link](https://github.com/open-mmlab/mmdetection/blob/master/docs/en/1_exist_data_model.md#prepare-datasets).
 
+### Run scripts
 ```bash
 # MMDetection Example
+mim install mmdet
 mim download mmdet --config faster_rcnn_r50_fpn_1x_coco --dest configs/mmdet/faster_rcnn
-python tools/tune.py configs/siatune/mmdet_asynchb_nevergrad_pso.py --trainable-args configs/mmdet/faster_rcnn/faster_rcnn_r50_fpn_1x_coco.py
+python tools/tune.py configs/mmdet/mmdet_asynchb_nevergrad_pso.py --trainable-args configs/mmdet/faster_rcnn/faster_rcnn_r50_fpn_1x_coco.py
 ```

requirements/optional.txt

@@ -1,7 +1,7 @@
 bayesian-optimization==1.2.0
 flaml==0.9.7
 hyperopt==0.2.5
-mlflow==1.21.0
+mlflow==1.23.1
 nevergrad==0.4.3.post7
 optuna==2.10.0
 scikit-learn