https://github.com/joelius300/ml-starter
Simple ML Starter Template for personal use
https://github.com/joelius300/ml-starter
Last synced: 27 days ago
JSON representation
Simple ML Starter Template for personal use
- Host: GitHub
- URL: https://github.com/joelius300/ml-starter
- Owner: Joelius300
- License: apache-2.0
- Created: 2023-11-22T12:00:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-18T09:09:36.000Z (about 1 year ago)
- Last Synced: 2024-10-06T06:21:54.065Z (7 months ago)
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ML Starter Template
My personal simple ML Starter Template using [pyenv](https://github.com/pyenv/pyenv), [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv), [DVC](https://github.com/iterative/dvc), and [PyTorch Lightning](https://github.com/Lightning-AI/pytorch-lightning). Feel free to use and expand/fork it.
## Use template
This section explains how to do the required one-time setup for the template.
TODO Use and delete
1. Adjust values below
2. Add requirements to `requirements.txt` if you need them
3. Run it all and commit
```bash
export PYTHON_VERSION=3.11.7
export VENV_NAME=????????
export DRIVE_ID=???????????
pyenv install $PYTHON_VERSION
pyenv virtualenv $PYTHON_VERSION $VENV_NAME
echo $VENV_NAME > .python-version
pip install -r requirements.txt
pip freeze > requirements.txt
dvc init
dvc install
dvc remote add --default gdrive "gdrive://$DRIVE_ID"
dvc remote modify gdrive gdrive_acknowledge_abuse true
nbstripout --install --attributes .gitattributes
```
## Init dev environment
This section explains how to set up the development environment on any subsequent computer after the template-setup is done and commited.
```bash
export PYTHON_VERSION=3.11.7
pyenv install $PYTHON_VERSION
pyenv virtualenv $PYTHON_VERSION $VENV_NAME
pip install -r requirements.txt
dvc install
nbstripout --install --attributes .gitattributes
```
## Links
TODO Update and add things like Dataset link, Zotero Group, etc.
- [GitHub Repo](https://github.com/?????)
- [DVC Google Drive Repo](https://drive.google.com/drive/folders/DRIVE_ID)
- [DVC Docs](https://dvc.org/doc)
- [Python Project Structure Guide](https://docs.python-guide.org/writing/structure/)