evalsuite-python 0.1.0a1__py3-none-any.whl

evalsuite_python-0.1.0a1.dist-info/METADATA

@@ -0,0 +1,150 @@
+Metadata-Version: 2.5
+Name: evalsuite-python
+Version: 0.1.0a1
+Summary: A unified Python framework for machine-learning, clinical, statistical, segmentation, object-detection, uncertainty, and model evaluation.
+Project-URL: Homepage, https://evalsuite-nine.vercel.app
+Project-URL: Documentation, https://evalsuite-nine.vercel.app/docs
+Project-URL: Source, https://github.com/mkcs28/evalsuite-python
+Project-URL: Issues, https://github.com/mkcs28/evalsuite-python/issues
+Project-URL: Changelog, https://github.com/mkcs28/evalsuite-python/blob/main/CHANGELOG.md
+Author: Manoj Kumar C S
+Maintainer: Manoj Kumar C S
+License-Expression: MIT
+License-File: LICENSE
+Keywords: classification,evaluation,machine learning,metrics,regression,reproducibility,statistics
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: numpy>=1.22
+Requires-Dist: pandas>=1.4
+Requires-Dist: scipy>=1.8
+Provides-Extra: all
+Requires-Dist: matplotlib>=3.5; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: hypothesis>=6.80; extra == 'dev'
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pandas-stubs; extra == 'dev'
+Requires-Dist: pip-audit; extra == 'dev'
+Requires-Dist: pytest-cov>=4; extra == 'dev'
+Requires-Dist: pytest>=7; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Requires-Dist: scikit-learn>=1.2; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Provides-Extra: plot
+Requires-Dist: matplotlib>=3.5; extra == 'plot'
+Description-Content-Type: text/markdown
+
+# EvalSuite
+
+[![CI](https://github.com/mkcs28/evalsuite-python/actions/workflows/ci.yml/badge.svg)](https://github.com/mkcs28/evalsuite-python/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/evalsuite-python)](https://pypi.org/project/evalsuite-python/)
+[![Python](https://img.shields.io/pypi/pyversions/evalsuite-python)](https://pypi.org/project/evalsuite-python/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+**Unified, reproducible evaluation for machine learning and research.**
+
+EvalSuite brings classification and regression metrics (with clinical, statistical, segmentation and
+object-detection evaluation on the roadmap) into one consistent, validated, documented framework.
+
+> **Status: in development (v0.1.0 in progress).** The API may change before 0.1.0.
+
+## Installation
+
+```bash
+pip install evalsuite-python
+```
+
+The package is installed as `evalsuite-python` and imported as `evalsuite`:
+
+```python
+import evalsuite as es
+```
+
+## Why EvalSuite
+
+- **One consistent API.** Every metric returns a result object that behaves like a number and exports to
+  JSON, pandas, Markdown and LaTeX.
+- **Explicit conventions.** Averaging, label order, the positive class and zero-division behaviour are stated
+  and recorded in every result, never silently assumed.
+- **Validated.** Each metric is tested against scikit-learn where definitions coincide, plus property-based
+  tests and edge cases.
+- **Documented.** Every metric carries its definition, formula, range, input requirements and references,
+  available programmatically through `metric_info()`.
+- **Efficient.** `evaluate()` validates inputs once and computes the confusion matrix once for all metrics.
+- **Lightweight.** Requires only NumPy, SciPy and pandas.
+
+## Quick start
+
+```python
+import evalsuite as es
+
+y_true = [0, 1, 1, 0, 1, 0]
+y_pred = [0, 1, 0, 0, 1, 1]
+y_prob = [0.1, 0.9, 0.4, 0.2, 0.8, 0.6]
+
+result = es.evaluate(y_true, y_pred, y_prob=y_prob)
+print(result.summary())
+
+result["f1"]  # MetricResult(f1=0.666667)
+f"{result['mcc']:.3f}"  # '0.333'
+result.to_latex(caption="Test-set performance")
+result.to_dataframe()
+
+es.f1(y_true, y_pred)  # individual metrics
+es.roc_auc(y_true, y_prob)
+es.metric_info("classification.mcc").formula  # documentation
+es.list_metrics("regression")
+```
+
+## Metrics in this release
+
+**Classification** (binary, multiclass, multilabel; micro/macro/weighted/samples/per-class averaging;
+sample weights): accuracy, balanced accuracy, precision, recall, specificity, NPV, F1, F-beta, Jaccard,
+MCC, Cohen's kappa (unweighted, linear, quadratic), Hamming loss, confusion matrix, ROC AUC (binary,
+one-vs-rest, one-vs-one), average precision, ROC and PR curves, log loss, Brier score, top-k accuracy.
+
+**Regression** (single and multi-output; sample weights): MAE, MSE, RMSE, R², adjusted R², MAPE, sMAPE,
+MSLE, RMSLE, median absolute error, explained variance, max error, mean bias error, quantile (pinball)
+loss, Huber loss, relative absolute error, relative squared error.
+
+## Conventions
+
+- `average="auto"` resolves to `"binary"` for binary targets and `"macro"` otherwise; the resolved value
+  is stored in `result.params["average"]`.
+- Labels are sorted unless you pass `labels=[...]`; that order defines per-class outputs and the columns
+  of 2-D `y_prob`.
+- Undefined ratios (zero denominators) return 0 **with an `UndefinedMetricWarning`**; pass
+  `zero_division=np.nan` to propagate NaN, or `0`/`1` to choose silently.
+- Domain violations raise clear errors instead of being patched over (for example MAPE with zero targets).
+
+## Development
+
+```bash
+python -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+pytest --cov=evalsuite
+ruff check . && ruff format --check . && mypy
+```
+
+## Links
+
+- PyPI: https://pypi.org/project/evalsuite-python/
+- Website and documentation: https://evalsuite-nine.vercel.app
+- Website source: https://github.com/mkcs28/evalsuite
+
+## License
+
+MIT. See [LICENSE](LICENSE).

evalsuite_python-0.1.0a1.dist-info/RECORD

@@ -0,0 +1,21 @@
+evalsuite/__init__.py,sha256=F1w6941ptTkxj2ypslarIx8KegXCFuTbxcaGg-DYpMA,2239
+evalsuite/api.py,sha256=x1hu_2Q06WN2NwFlGO4CfIcXZz0bjkQ66QAxMFfGmeo,9107
+evalsuite/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+evalsuite/version.py,sha256=4QyIQYHnJ3CLZp00htZ8iaV8KmLrqSkoXFZtHHrL4ic,100
+evalsuite/classification/__init__.py,sha256=5EaNh2vrGBuOlxQp0r5e-A52egAzK0vVE3mlLOj9JEw,719
+evalsuite/classification/_common.py,sha256=3ANV33ix_mnOzvOAG8glyJO-iYVhhTGO0S3YG0ZddB8,4543
+evalsuite/classification/metrics.py,sha256=0EpPcKnOSdcRmrRHbbAykKDqSdWKy67-kk2GXVWofLk,33682
+evalsuite/core/__init__.py,sha256=oDHl5Dc2GoZf1tCtJueMQ2KcmOq7zhzMZT9XF4uVC6U,93
+evalsuite/core/context.py,sha256=gvRpH3b-S2oAgAGW9W0XWnBVbuydQP3UB9rgWQNM60g,7874
+evalsuite/core/exceptions.py,sha256=9eZI_Lmgwc9fjkSUY9s3fwjAb7KoqgAlcYetrHRhbBg,1503
+evalsuite/core/registry.py,sha256=3l2_o2PlckuKY89HxfnxPLf-sDaCe_-McUcAcUmXusk,2884
+evalsuite/core/result.py,sha256=YGivFboHri-ny0CN3HhzDwRQdo0OmrswZZhRDNk605I,10577
+evalsuite/core/types.py,sha256=r6bhUk7CYAcrlQzjmf-6xWQsNqO3EOipZD-e-2yAJTI,720
+evalsuite/core/validation.py,sha256=EIAd6m5DIguFM4wLUNVissEYqvjylYEuLGrPq8hOUpw,8350
+evalsuite/regression/__init__.py,sha256=t2XEHUw6e5tyWBHcEeiog2WWd-wwaxf4m5AIX8dJyng,571
+evalsuite/regression/metrics.py,sha256=4_6tIwNukGI5WRbSnDH1E3SI5utplEgERTzC-2RHb3A,21757
+evalsuite_python-0.1.0a1.dist-info/METADATA,sha256=xqguxCZSUJ7MkkXiuM9aY1R6dXR3ewMw-DapMsz7meU,6154
+evalsuite_python-0.1.0a1.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+evalsuite_python-0.1.0a1.dist-info/entry_points.txt,sha256=YYIwisn4L4sQt3ntzbM0_Z4yZE2KCu3GJ6KfWL1kIwc,54
+evalsuite_python-0.1.0a1.dist-info/licenses/LICENSE,sha256=GGh6ACzs6Gih4IlfbWxzHvkNKC1E9EQ3eVWW0Njpafk,1072
+evalsuite_python-0.1.0a1.dist-info/RECORD,,

evalsuite_python-0.1.0a1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

evalsuite_python-0.1.0a1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+evalsuite = evalsuite.cli.main:main

evalsuite_python-0.1.0a1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Manoj Kumar C S
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.