Skip to main content

A package to auto-generate structured ML project folders

Project description

Here is the correctly formatted README.md file:

# ml_project_setup  
*A simple package for setting up a structured Machine Learning project.*

## ๐Ÿ“– Overview  
`ml_project_setup` helps you quickly set up a standardized Machine Learning project structure with best practices.

## ๐Ÿ“‚ Project Structure Created  
After running `mlsetup my_project`, the following structure is created:

my_project/ โ”‚โ”€โ”€ source/ โ”‚ โ”œโ”€โ”€ components/ โ”‚ โ”œโ”€โ”€ constants/ โ”‚ โ”œโ”€โ”€ entity/ โ”‚ โ”œโ”€โ”€ pipeline/ โ”‚ โ”œโ”€โ”€ utility/ โ”‚ โ”œโ”€โ”€ exception/ โ”‚ โ”œโ”€โ”€ logger/ โ”‚โ”€โ”€ .gitignore โ”‚โ”€โ”€ README.md โ”‚โ”€โ”€ requirements.txt โ”‚โ”€โ”€ main.py โ”‚โ”€โ”€ setup.py


## ๐Ÿ›  Installation  
You can install the package using:
```sh
pip install ml_project_setup

๐Ÿš€ Usage

To create a new Machine Learning project, run:

mlsetup my_project

This will generate a structured ML project named my_project in the current directory.

๐Ÿ“ฆ Dependencies

This package requires:

  • numpy
  • pandas
  • scikit-learn

You can install dependencies using:

pip install -r requirements.txt

๐Ÿ“ License

This project is licensed under the MIT License. See the LICENSE file for details.

๐Ÿ‘ค Author

Developed by Amogh
For any issues or suggestions, contact: ๐Ÿ“ง amogh9792@gmail.com


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

ml_project_setup-0.3.tar.gz (4.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ml_project_setup-0.3-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file ml_project_setup-0.3.tar.gz.

File metadata

  • Download URL: ml_project_setup-0.3.tar.gz
  • Upload date:
  • Size: 4.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.5

File hashes

Hashes for ml_project_setup-0.3.tar.gz
Algorithm Hash digest
SHA256 e28fa573c8052bca0815a84c5fbb729ae68ebf297884aa4c01fc47ee43d17dc0
MD5 17fe2deea9e702a869329b3052bc7a2e
BLAKE2b-256 2ac71725de8a7e6d90a2acbf1db18934525cc9925fd5eef10e04ac14d7c20645

See more details on using hashes here.

File details

Details for the file ml_project_setup-0.3-py3-none-any.whl.

File metadata

  • Download URL: ml_project_setup-0.3-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.5

File hashes

Hashes for ml_project_setup-0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6874346bd993d937bc025a0941e0ee792e9d8d7398b0c590bda2f2497e772446
MD5 14f9c4d209469f0609161e7b3068c65f
BLAKE2b-256 0e9b6c28ddab6efaceefe481b6e27f2be7325be144ca2d6c259708f2814cf86a

See more details on using hashes here.

Supported by

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