Skip to main content

a package for calculating global performance indicator (GPI)

Project description

GPI Calculator

Welcome to GPI Calculator

A Package for Calculating Global Performance Indicator (GPI)
Use the GPI Calculator to compute a comprehensive performance metric for your models.

Introduction

The GPI was introduced by Despotovic, et al. (2015) in their publication "Review and statistical analysis of different global solar radiation sunshine models". The motivation of creating the GPI was to combine multiple performance evaluation metrics into a single numerical representation for multi-dimensional and comprehensive comparison of different artificial intelligence/empirical models. The GPI metric has been cited and used in various articles such as:

  • Chia, M.Y., Huang, Y.F. and Koo, C.H., 2021. Improving reference evapotranspiration estimation using novel inter-model ensemble approaches. Computers and Electronics in Agriculture, 187, p.106227.
  • Chia, M.Y., Huang, Y.F. and Koo, C.H., 2022. Resolving data-hungry nature of machine learning reference evapotranspiration estimating models using inter-model ensembles with various data management schemes. Agricultural Water Management, 261, p.107343.

Installation

pip install gpicalc

Example

We can import the test.xlsx supplied in the repository using the following lines:

import pandas as pd

data = pd.read_excel('test.xlsx', index_col=0)

This will give you a DataFrame named "data" that has 3 columns (MAE, RMSE and R2) and 30 rows (30 different models).

Next, import the "GPICalculator" class from the gpi package to create a GPICalculator object.

from gpicalc import GPICalculator

calculator = GPICalculator()

To obtain the GPI score, use the GPICalculator.score() method by including "data" and a list of coefficient as the parameters.

coefficient = [1, 1, -1] # Use positive coefficient for metrics to be minimised (MAE, RMSE), and negative coefficient for metrics to be maximized (R2)
gpi_score = calculator.score(data, coefficient) # GPI is positive-oriented, the higher the better

Support

For any suggestions or feedbacks, I will be available at this repository or chiamy94@gmail.com.

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

gpicalc-0.6.0.tar.gz (2.7 kB view details)

Uploaded Source

Built Distribution

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

gpicalc-0.6.0-py3-none-any.whl (2.9 kB view details)

Uploaded Python 3

File details

Details for the file gpicalc-0.6.0.tar.gz.

File metadata

  • Download URL: gpicalc-0.6.0.tar.gz
  • Upload date:
  • Size: 2.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.3

File hashes

Hashes for gpicalc-0.6.0.tar.gz
Algorithm Hash digest
SHA256 f058131cf2866284670adafa58b59e1b2e0d62b948f5c9777a923cb0f1d983ff
MD5 ad5bd99e24af9bab5e98fd0793a5837e
BLAKE2b-256 51bbc8bf52272f74f1077c26ad3e2421378151ee836dff4e1aa6c29162d6577c

See more details on using hashes here.

File details

Details for the file gpicalc-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: gpicalc-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 2.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.3

File hashes

Hashes for gpicalc-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0a6368ef20b4a7779b7ff1fbb7e49a906803efab649259c11734c3240d24793b
MD5 ecab53ecd868709b0c2050c069e5830a
BLAKE2b-256 768f6ee6c6cccc556db42bf0438e94806b6d21c8e770e906841b0ca841e21642

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