Metadata-Version: 2.4
Name: Modeva
Version: 2.0.3
Summary: Integrated tool for model development and validation.
Author-email: admin@modeva.ai
License: proprietary
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.12,<3.13
Description-Content-Type: text/markdown
License-File: LICENSE_DESIGN.md
Requires-Dist: setuptools<81
Requires-Dist: mlflow==2.15.1
Requires-Dist: ipywidgets>=7.7.0
Requires-Dist: ipython>=7.12.0
Requires-Dist: ipyvuetify>=1.8.10
Requires-Dist: notebook>=7.0.0
Requires-Dist: uvicorn
Requires-Dist: fastapi
Requires-Dist: webdriver-manager>=4.0.2
Requires-Dist: selenium>=4.19.0
Requires-Dist: matplotlib
Requires-Dist: networkx
Requires-Dist: requests
Requires-Dist: typer<0.10.0
Requires-Dist: packaging>=20.5
Requires-Dist: numpy<=1.26.4,>=1.21.4
Requires-Dist: scipy>=1.5.3
Requires-Dist: pandas>=1.3.5
Requires-Dist: catboost
Requires-Dist: xgboost>=1.6.0
Requires-Dist: lightgbm>=3.3.2
Requires-Dist: scikit-learn<1.7.0,>=1.3.0
Requires-Dist: scikit-learn-extra
Requires-Dist: torch!=2.3.*,>=1.11.0
Requires-Dist: momentchi2
Requires-Dist: umap-learn
Requires-Dist: pyswarms
Requires-Dist: lime>=0.2.0.1
Requires-Dist: shap>=0.42.0
Requires-Dist: pyjwt>=2.6.0
Requires-Dist: cryptography>=3.4
Requires-Dist: tqdm
Requires-Dist: dill
Requires-Dist: httpx
Requires-Dist: python-dateutil
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# MoDeVa

Integrated toolkit for interpretable model development and validation, with its
accompanying documentation, examples and monograph.

The repository is organized into six top-level sections:

| Folder | Contents |
|---|---|
| [`1-source-code/`](1-source-code/) | The `modeva` Python package, `setup.py`, requirements, build scripts and the Sphinx documentation config. |
| [`2-user-guide/`](2-user-guide/) | User guide (reStructuredText), covering feature engineering, DirectRS, ICL-MoE, FuseKernel and AMIF. |
| [`3-api-reference/`](3-api-reference/) | API reference (reStructuredText, generated by autodoc from the package). |
| [`4-notebook-examples/`](4-notebook-examples/) | Jupyter notebook examples: low-code and high-code walkthroughs and datasets. |
| [`5-monograph/`](5-monograph/) | The MoDeVa monograph (LaTeX source and compiled PDF) with its per-chapter notebook companions. |
| [`6-agent/`](6-agent/) | The MoDeVa data-science agent and its vLLM deployment tooling. |

## Installation

Install the package from its source folder:

```bash
cd 1-source-code
python -m pip install .
```

For an editable development install:

```bash
python -m pip install -e 1-source-code
```

## Documentation

The user guide, API reference and gallery build as a single Sphinx site. The
configuration lives in `1-source-code/docs/`; the source directory is the
repository root, so the build pulls content from `2-user-guide/`,
`3-api-reference/` and the generated gallery.

```bash
cd 1-source-code/docs
make html          # output in 1-source-code/docs/_build/html
```

Building the gallery requires `sphinx`, `sphinx-gallery`, `numpydoc` and
`sphinx_rtd_theme` in addition to the package dependencies.

## Monograph

The compiled monograph is `5-monograph/modeva_monograph.pdf`. To rebuild from
source, compile `5-monograph/modeva_monograph.tex` with a LaTeX toolchain; the
executed notebook companions are under `5-monograph/notebooks/`.
