Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs/get_started.md #92

Merged
merged 2 commits into from
Dec 14, 2022
Merged

Update docs/get_started.md #92

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b2c0315
Update docs/get_started.md
KKIEEK Dec 2, 2022
ee313b3
Fix typo
KKIEEK Dec 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions docs/get_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,41 @@

## Dockerfile (RECOMMENDED)
```bash
docker build . -t siatune:master -f docker/Dockerfile
docker build . -t siatune:main -f docker/Dockerfile
```

## Build From Source

```bash
# 1. install pytorch
# 1. Install PyTorch
pip install torch torchvision -f https://download.pytorch.org/whl/torch_stable.html
# 2. install mmcv
pip install mmcv-full -f https://download.openmmlab.com/mmcv/dist/{cu_version}/{torch_version}/index.html
# 3. clone siatune
git clone -b master https://github.com/SIAnalytics/siatune.git siatune
# 4. install siatune
cd siatune && pip install -e .

# 2. Install MIM and MMCV
pip install openmim
mim install mmcv-full

# 3. Install SIATune
git clone https://github.com/SIAnalytics/siatune.git
cd siatune
pip install -e '.[optional]'
```

# Hyperparamer tuning with OpenMMLab's model frameworks.

### Install OpenMMLab's framework.
```bash
# MMDetection Example
pip install mmdet
mim install mmdet
```

### Start hyperparameter tuning with existed configuration file.
```bash
python tools/tune.py ${TUNE_CONFIG} [optional tune arguments] [optional task arguments]
python tools/tune.py ${TUNE_CONFIG} [optional tune arguments] --trainable-args [optional task arguments]
```


```bash
# MMDetection Example
python tools/tune.py configs/siatune/mmdet_asynchb_nevergrad_pso.py --trainable_args configs/mmdet/faster_rcnn/faster_rcnn_r50_fpn_1x_coco.py
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
```