Skip to content

Commit

Permalink
Edit README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jungin500 committed Apr 5, 2022
1 parent 25ce388 commit 928d2fb
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
Easy-to-use PyTorch Lightning CNN model training template with **MobileNetV2** and **ImageNet** dataloader example

# Usage (`conda` recommended)
```bash
# Change "torch-trainer" to your new environment name
export CONDA_ENV=torch-trainer

# Create new environment along with PyTorch (with GPU support compatible up to RTX 3xxx series)
conda create -n $CONDA_ENV -c pytorch python=3.9 pytorch torchvision cudatoolkit=11.3
conda activate $CONDA_ENV
pip3 install -r requirements.txt

# ... Edit model, configuration

# Go ahead training your model!
python3 train.py wandb.login_key=123abc model.type=large ...
```

## Details
- [PyTorch Lightning](https://www.pytorchlightning.ai/) for easy-to-use NVIDIA AMP(Automatic Mixed Precision) and Tensorflow-like callback functions (`pytorch_lightning.callbacks.ModelCheckpoint`, `pytorch_lightning.callbacks.LearningRateMonitor`, so on)
- [Wandb](https://wandb.ai) for hyperparameters, loss, accuracy, model parameters and GPU usage logging
Expand Down

0 comments on commit 928d2fb

Please sign in to comment.