Metadata-Version: 2.1
Name: EzMetrics
Version: 1.0
Summary: An easy package to use for to get metrics from your models
Home-page: https://github.com/JieWuu/EzMetrics
Download-URL: https://github.com/JieWuu/EzMetrics/archive/refs/tags/v_1.0.tar.gz
Author: Jie Wu, Asier Marinero
Author-email: jie.wu@alumni.mondragon.edu, asier.marinero@alumni.mondragon.edu
License: MIT
Keywords: Easy,Metrics,Model
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# EzMetrics
## _The eaziest metrics library ever_

Ez metrics is a library that calculates the fitness metrics of your ML model.

## Features

- Support for fixed binary classification as well as probability based classification
- Support for regression models
- Up to 6 different metrics



And of course EzMetrics itself is open source with a [public repository][ezm] on GitHub.

## Installation

EzMetrics requires no extra libraries to run.

```sh
pip install EzMetrics

from EzMetrics import Metrics as ezm
```
## Usage

Create an object containing a list with the predictions of your model and a list 
containing the actual values por each prediction.

```sh
exmpl_obj = ezm( predicted_list, observed_list)
```

Then just choose a metric suited for your data and use it. 
In case of Mean Absolute Error it would be as follows.

```sh
exmpl_obj.mae()
```


## Metrics

EzMetrics has 6 different metrics available, which one to use depends on your data type.

| Discrete classification |  |
| ------ | ------ |
| Accuracy | Metrics.accuracy() |
| F1 score | Metrics.f1() |


| Probability classification |  |
| ------ | ------ |
| Area Under the Curve (AUC) | Metrics.roc_auc() |


| Regression |  |
| ------ | ------ |
| R squared | Metrics.r2() |
| Mean Absolute Error | Metrics.mae() |
| Mean Squared Error | Metrics.mse() |


## License

MIT

   [ezm]: <https://github.com/JieWuu/EzMetrics>
