Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Removed `python -m pip install -r requirements.txt` from the default given run command to avoid borking people's pre-existing torch and torchvision installations (more likely+critical than someone not having an installation).

Added some documentation for people new to torch/torchvision.
  • Loading branch information
tysam-code committed Aug 16, 2023
1 parent 3bb104c commit ff53cac
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,13 @@ Welcome to the hyperlightspeedbench CIFAR-10 (HLB-CIFAR10) repo.
### How to Run


`git clone https://github.com/tysam-code/hlb-CIFAR10 && cd hlb-CIFAR10 && python -m pip install -r requirements.txt && python main.py`
`git clone https://github.com/tysam-code/hlb-CIFAR10 && cd hlb-CIFAR10 && python main.py`

Requires CUDA. Can be modified for other platforms with mild difficulty.

If you don't have torch and/or torchvision installed, please run:

`python -m pip install -r requirements.txt` after cd-ing into the hlb-CIFAR10 folder, then `python main.py` instead.

If you're curious, this code is generally Colab friendly (in fact -- most of this was developed in Colab!). Just be sure to uncomment the reset block at the top of the code.

Expand Down

0 comments on commit ff53cac

Please sign in to comment.