Skip to main content

Templating tool with boiler plate code for building robust machine learning projects in python.

Project description

ML Template

ML template is an easy-to-use tool to automate the boilerplate code for most machine learning projects.

This tool creates a user-oriented project architecture for machine learning projects.

Modify the code under #TODO comments in the template project repository to easily adapt the template to your use-case.

How to use it?

  1. Install the package as - pip install mltemplate
  2. Then, simply run mltempate from your terminal and follow the prompts

And Voila!

This creates a project directory in your current folder similar to -

template
├── Dockerfile.cpu
├── Dockerfile.gpu
├── LICENSE.md
├── Makefile
├── README.md
├── jupyter.sh
├── requirements.txt
└── template
    ├── __init__.py
    ├── __main__.py
    ├── cli
    │   ├── __init__.py
    │   ├── predict.py
    │   └── train.py
    ├── notebooks
    └── src
        ├── __init__.py
        ├── models.py
        ├── datasets.py
        └── transforms.py

All you have to do next is -

  1. Update python frameworks and versions in template/requirements.txt as need for your project
  2. Head to template/datasets.py and modify create a new dataset that will work for your use case
  3. Navigate to template/models.py and create a new model class with your sota (or not) architecture
  4. In template/transforms.py add transforms such as Normalizer, Denormalize etc.
  5. Follow the TODO steps in template/cli/train.py and template/cli/predict.py to make the necessary changes

Checkout the README.md in the template directory for further instructions on how to train, predict and also monitor your loss plots using tensor board.

Future Work

Currently, this package only supports boilerplate creation for ML projects in pytorch

We plan to support tensorflow in the future.

License

Copyright © 2020 Sowmya Yellapragada

Distributed under the MIT License (MIT).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mltemplate-1.0.0.tar.gz (40.1 kB view details)

Uploaded Source

Built Distribution

mltemplate-1.0.0-py3-none-any.whl (42.6 kB view details)

Uploaded Python 3

File details

Details for the file mltemplate-1.0.0.tar.gz.

File metadata

  • Download URL: mltemplate-1.0.0.tar.gz
  • Upload date:
  • Size: 40.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.16 Darwin/22.6.0

File hashes

Hashes for mltemplate-1.0.0.tar.gz
Algorithm Hash digest
SHA256 a525880cd3ff7b3791a02499460d19d59cf68378fef35d997405f2b0a09e93cb
MD5 63808ccce98e1577ade81b7e9bc2baba
BLAKE2b-256 fd38fd33320e96a5e4fedb9dddbb01a690b7ca8af1584c6ccca3ef178b11276d

See more details on using hashes here.

File details

Details for the file mltemplate-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: mltemplate-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 42.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.16 Darwin/22.6.0

File hashes

Hashes for mltemplate-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5e2ae41a5c5af0da34edea8f47b223332dea2d3b73402af542df28e1fa358de0
MD5 e7c3601e5d5a8d97b3d0642a49d931b9
BLAKE2b-256 88fb8629a89cc35c5e9cd3fbd0e85b9a802e0414efeb51e87ccdef23c30e1afd

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page