How thieu1995/permetrics works
PerMetrics is a Python library for computing regression, classification, and clustering performance metrics. Users provide reference and predicted values (and, for internal clustering metrics, feature data), instantiate a metric evaluator, then call one metric or request several by name to obtain results. The package exposes three domain-specific metric classes over a shared evaluator, with data-formatting and calculation helpers beneath them. The README documents the public workflow and metric breadth; implementation relationships below rely on the supplied excerpts and SOURCE INDEX, so unsampled details are not expanded.
Main entry points: evaluator.py Metric evaluator · __init__.py Package exports · regression.py Regression metrics · classification.py Classification metrics
Components 12
Public API
- Package exports
permetrics/__init__.py
Metric Domains
- Regression metrics
permetrics/regression.py - Classification metrics
permetrics/classification.py - Clustering metrics
permetrics/clustering.py
Shared Evaluation
- Metric evaluator
permetrics/evaluator.py
Calculation Helpers
- Data formatting
permetrics/utils/data_util.py - Regression calculations
permetrics/utils/regressor_util.py - Classification calculations
permetrics/utils/classifier_util.py - Clustering calculations
permetrics/utils/cluster_util.py - Label encoding
permetrics/utils/encoder.py
Other components
- Python user
- Metric results
Connections 20
- Python user → Package exports: imports API
README.md - Package exports → Metric evaluator: exports
permetrics/__init__.py - Package exports → Regression metrics: exports
permetrics/__init__.py - Package exports → Classification metrics: exports
permetrics/__init__.py - Package exports → Clustering metrics: exports
permetrics/__init__.py - Python user → Regression metrics: provides data
README.md - Python user → Classification metrics: provides labels
- Python user → Clustering metrics: provides clusters
- Regression metrics → Metric evaluator: inherits
permetrics/regression.py - Classification metrics → Metric evaluator: inherits
permetrics/classification.py - Clustering metrics → Metric evaluator: inherits
permetrics/clustering.py - Regression metrics → Data formatting: formats data
permetrics/regression.py - Regression metrics → Regression calculations: uses calculations
permetrics/regression.py - Classification metrics → Data formatting: formats data
permetrics/classification.py - Classification metrics → Classification calculations: uses calculations
permetrics/classification.py - Clustering metrics → Data formatting: formats data
permetrics/clustering.py - Clustering metrics → Clustering calculations: uses calculations
permetrics/clustering.py - Data formatting → Label encoding: uses encoder
permetrics/utils/data_util.py - Metric evaluator → Metric results: returns results
permetrics/evaluator.py - Python user → Metric evaluator: requests metrics
README.md