modinit
modinit is a Python package that helps you quickly scaffold AI model training repositories with a standardized, best-practice structure. It saves you time and ensures consistency across your machine learning projects.
Why use modinit?
- Instant project setup: Get started with a ready-to-use directory structure in seconds.
- Best practices built-in: Follows common conventions for organizing data, code, configs, and tests.
- Docstring templates: All generated Python files include helpful docstrings.
- Easy to use: Simple command-line interface.
Demo
Installation
pip install modinit
Usage
To create a new project, run:
modinit my-project
This will generate a new directory called my-project with a recommended structure for AI/ML projects.
Example
Below is a real example of using modinit to create a project called voice-rumba:
$ pip install modinit
$ modinit voice-rumba
Successfully created project: voice-rumba
To get started, navigate to the project directory:
cd voice-rumba
The generated structure looks like this:
voice-rumba/
├── README.md
├── .gitignore
├── configs/
│ └── config.yaml
├── data/
│ ├── raw/
│ ├── processed/
│ └── interim/
├── main.py
├── notebooks/
│ └── prototype.ipynb
├── requirements.txt
├── src/
│ ├── __init__.py
│ ├── data.py
│ ├── evaluate.py
│ ├── model.py
│ ├── train.py
│ └── utils.py
└── tests/
├── __init__.py
├── test_data.py
├── test_model.py
└── test_train.py
Features
- Creates a well-structured project directory for AI model training
- Follows best practices for machine learning project organization
- Includes helpful docstrings in all generated files
- Simple command-line interface
Development
To contribute to this project:
- Clone the repository
- Create a virtual environment
- Install development dependencies:
pip install -e ".[dev]" - Make your changes
- Run tests:
pytest
License
MIT
Metadata
Release files for modinit 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| modinit-0.1.1.tar.gz | 14.7 kB | Without provenance | Details for modinit-0.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| modinit-0.1.1-py3-none-any.whl | Python 3 | none | any | Details for modinit-0.1.1-py3-none-any.whl |
Total release size: 34.4 kB
Release files / modinit-0.1.1.tar.gz
| Download URL | modinit-0.1.1.tar.gz |
|---|---|
| Size | 14.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1bd46f2b2e7f522a028088de8ba6cee805d6a5dc06f5a6486805157ab191cf16
|
|
BLAKE2b-256 checksum How to use checksums |
48bca4cf05768051c38abf1b9aa2af6a3a3749b6534422d3e49711cb271cd58b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.10
|
Release files / modinit-0.1.1-py3-none-any.whl
| Download URL | modinit-0.1.1-py3-none-any.whl |
|---|---|
| Size | 19.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a87ef62c8cebe96dbb548f5f0413d569be79afd3a0d97234cd64527fc5a3b4a3
|
|
BLAKE2b-256 checksum How to use checksums |
e71e80a07d5d39a3a15a32c96ca67d968f78b5a3c920e8c6f2ea4e2c4613b85a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.10
|
Security for modinit 0.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.