Metadata-Version: 2.4
Name: mlvern
Version: 0.2.0
Summary: mlvern v0.2.0, This Enhanced ML Workflow Framework with a better API, 
Author: Tanmai Raghava
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas
Requires-Dist: scikit-learn
Requires-Dist: matplotlib
Requires-Dist: joblib
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: coveralls; extra == "dev"
Requires-Dist: docopt; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"
Requires-Dist: black>=22.0; extra == "dev"
Requires-Dist: isort>=5.0; extra == "dev"
Requires-Dist: flake8>=4.0; extra == "dev"
Requires-Dist: mypy>=0.900; extra == "dev"
Requires-Dist: bandit>=1.7; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=4.0; extra == "docs"
Requires-Dist: sphinx_rtd_theme>=1.0; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints>=1.12; extra == "docs"
Dynamic: license-file

# mlvern

[![PyPI Version](https://img.shields.io/pypi/v/mlvern)](https://pypi.org/project/mlvern/)
[![PyPI Downloads](https://img.shields.io/pypi/dm/mlvern)](https://pypi.org/project/mlvern/)
[![Documentation Status](http://readthedocs.org/projects/ml-vern/badge/?version=latest)](http://ml-vern.readthedocs.io/en/latest/?badge=latest)
[![Build Status](https://img.shields.io/github/actions/workflow/status/N-T-Raghava/ml-vern/test.yml)](https://github.com/<username>/ml-vern/actions)
[![Coverage Status](https://coveralls.io/repos/github/N-T-Raghava/ml-vern/badge.svg?branch=main)](https://coveralls.io/github/N-T-Raghava/ml-vern?branch=main)
[![codecov](https://codecov.io/gh/N-T-Raghava/ml-vern/graph/badge.svg?token=KZIEXD9ALC)](https://codecov.io/gh/N-T-Raghava/ml-vern)
[![Type Checked](https://img.shields.io/badge/mypy-checked-blue)](https://github.com/python/mypy)
[![Code Style: Black](https://img.shields.io/badge/code%20style-black-000000)](https://github.com/psf/black)
[![Security: Bandit](https://img.shields.io/badge/security-bandit-yellow)](https://github.com/PyCQA/bandit)
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)]((https://img.shields.io/github/license/mashape/apistatus.svg))

mlvern is a lightweight Python framework for building reproducible and well-organized machine learning workflows. It provides clear tooling for dataset management, experiment tracking, model versioning, and evaluation reporting.

Project documentation: https://ml-vern.readthedocs.io/en/latest/

---

## Purpose

Machine learning projects often become difficult to maintain due to scattered datasets, untracked experiments, and inconsistent model artifacts. mlvern addresses these problems by offering a simple and deterministic project structure where heavy data inspection and analysis are performed only once per unique dataset fingerprint.

The framework is suitable for:
- Individual ML practitioners
- Research prototyping
- Academic projects
- Small to medium ML teams

---

## Core Capabilities

- Dataset registration and fingerprinting  
- Persistent metadata storage  
- Automated exploratory data analysis  
- Experiment run management  
- Model artifact registry  
- Standardized prediction interface  
- Evaluation and metric comparison  
- Cleanup and pruning utilities  

---

## Development Philosophy

mlvern follows these principles:

- Deterministic dataset fingerprinting
- One-time heavy data inspection
- Minimal and explicit APIs
- Clear artifact organization
- Easy comparison between runs
- Simple prediction and evaluation helpers

## Installation

Install the latest stable version from PyPI:

```bash
pip install mlvern
