Skip to main content

Metrics for Evaluating Model Quality

Project description

Irrectum - Metrics for Evaluating Model Quality

Description

Irrectum provides a set of metrics for evaluating the quality of machine learning model predictions. These metrics include both standard and specialized indicators that help analyze model performance and identify its strengths and weaknesses.

Features

  • RMSE (Root Mean Square Error): Assesses the error of the model's values relative to the actual values.
  • NRMSE (Normalized RMSE): Normalizes RMSE, allowing for comparison of models with different scales.
  • Pearson Correlation Coefficient: Measures the degree of linear dependence between predicted and actual values.
  • Covariance: Evaluates how two variables change together.
  • Coefficient of Determination (R²): Shows the proportion of variance in the dependent variable explained by the model.
  • Adjusted R²: Takes into account the number of predictors in the model, allowing for comparison of models with different numbers of factors.
  • Residual Sum of Squares (RSS): Assesses the total error of the model.
  • MAPE (Mean Absolute Percentage Error): Measures the percentage error of the model relative to the original.
  • MAE (Mean Absolute Error): Evaluates the average error between predicted and actual values.
  • AIC & BIC: Information criteria for comparing models considering their complexity.

Installation

To install the necessary dependencies, use the following command:

pip install irrectum

Example of using the metrics:

import numpy as np
from abc_metrics import RMSE, MAE

# Example data
testTarget = np.array([3, -0.5, 2, 7])
testPrediction = np.array([2.5, 0.0, 2, 8])

# Creating instances of the metrics
rmse_metric = RMSE()
mae_metric = MAE()

# Evaluating model quality
rmse_value = rmse_metric.test(testTarget, testPrediction)
mae_value = mae_metric.test(testTarget, testPrediction)

print(f"RMSE: {rmse_value}, MAE: {mae_value}")

Support

If you have any questions or need assistance, please create an issue in the repository.

Contributing

We welcome contributions! Please refer to our contribution guidelines.

Authors and Acknowledgment

Show your appreciation to those who have contributed to the project.

License

This project is licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

irrectum-0.1.1.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

irrectum-0.1.1-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file irrectum-0.1.1.tar.gz.

File metadata

  • Download URL: irrectum-0.1.1.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.0

File hashes

Hashes for irrectum-0.1.1.tar.gz
Algorithm Hash digest
SHA256 4ada26495d819760407fad8f1d0492a52678d00b096a260fafae2fc291237040
MD5 411bf685fb53e9cde99d33636316c4b0
BLAKE2b-256 b60f04883804f19fafd2e30472dcf203b3ea296f8016edb194654b8978ff40bf

See more details on using hashes here.

File details

Details for the file irrectum-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: irrectum-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 5.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.0

File hashes

Hashes for irrectum-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8b09f2f3e94f68e0ad1f093bb388c6b7cdd0dcecdc17e7b0128df8ea5e017143
MD5 9be8cbff7e5535e052f72489596f9a49
BLAKE2b-256 990eef6a29343f006dea4346e79a0e8ad56cccc5509b945d8aa8a247361876cf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page