https://github.com/thesofakillers/mlcookiecutter
Python cookiecutter template for ML projects with Poetry
https://github.com/thesofakillers/mlcookiecutter
Last synced: 10 months ago
JSON representation
Python cookiecutter template for ML projects with Poetry
- Host: GitHub
- URL: https://github.com/thesofakillers/mlcookiecutter
- Owner: thesofakillers
- License: gpl-3.0
- Created: 2022-05-12T10:11:55.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-12-01T15:59:04.000Z (over 3 years ago)
- Last Synced: 2025-05-07T19:03:32.056Z (about 1 year ago)
- Language: Shell
- Size: 22.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Python cookiecutter Machine Learning template
This is a [cookiecutter](https://github.com/cookiecutter/cookiecutter) template
for my machine learning projects. This is a modified version of the
[data science cookiecutter](https://drivendata.github.io/cookiecutter-data-science/)
template, with less files and the addition of
[poetry](https://python-poetry.org/)
## Usage
Make sure `cookiecutter` is installed
```terminal
pip install cookiecutter
```
Then run cookiecutter with this template:
```terminal
cookiecutter https://github.com/thesofakillers/mlcookiecutter
```
After initializing, remember to:
1. create the appropriately versioned python environment, if you wish to use
environments
2. `cd` to the generated directory
3. Run `git init` to initialize version control
1. setup a remote address optionally
4. optionally add a LICENSE file, updating `pyproject.toml` file accordingly
5. run `poetry update` to generate a `poetry.lock` file.
6. commit the contents of the directory.