Skip to main content

Centered Isotonic Regression (CIR) is a strictly monotonic, nonparametric regression model

Project description

License

Introduction

The cir-model library implements the Centered Isotonic Regression (CIR) model.[1] CIR is a variant of Isotonic Regression (IR), which is a nonparametric regression model which only assumes that the data generating function is monotonically increasing or decreasing. The function can take any monotonic form that minimizes the sum of squared errors. scikit-learn has implemented Isotonic Regression as IsotonicRegression.[2]

In some scenarios, the assumption of monotonicity is too weak. IR can result in a function that has constant, non-decreasing intervals. In some applications, like dose-response curve fitting or in cumululative distribution function estimation, it can be safe to make the additional assumption of strict monotonicity: at any point the function should be increasing, not just non-decreasing (or vice versa: decreasing, not just non-increasing). This additional requirement results in a function with the desirable property that the inverse function is a unique mapping, because there are no longer ranges of constant intervals.

Centered Isotonic Regression (CIR) is similar to IR, but with the additional assumption of strict monotonicity. The algorithm is described in detail in [1]. The plot below shows a comparison of IR (in blue) and CIR (in red) fitted to the same datapoints (in green).

This Python library, cir-model, implements CenteredIsotonicRegression in line with the algorithm in [1]. cir-model uses the IsotonicRegression implementation of scikit-learn. Therefore, CenteredIsotonicRegression takes the same parameters as IsotonicRegression and is completely compatible with scikit-learn. You can use it for example in scikit-learn pipelines.

You can install cir-model using pip:

pip install -U cir-model

Examples

To fit a CIR model:

>>> from cir_model import CenteredIsotonicRegression
>>> x = [1, 2, 3, 4]
>>> y = [1, 37, 42, 5]
>>> model = CenteredIsotonicRegression().fit(x, y)
>>> model.transform(x)
array([ 1. , 14.5, 28. , 28. ])

Finding the inverse of the CIR model above, for example for the value x for which y=25:

>>> from scipy import optimize
>>> optimize.newton(lambda x: model.transform([x]) - 25, 2)
array([2.77777778])

References

  1. Centered Isotonic Regression: Point and Interval Estimation for Dose-Response Studies, Assaf P. Oron & Nancy Flournoy, Statistics in Biopharmaceutical Research, Volume 9, Issue 3, 258-267, 2017
  2. Scikit-learn: Machine Learning in Python, Fabian Pedregosa et al., JMLR 12, 2825-2830, 2011

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

cir-model-0.2.0.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

cir_model-0.2.0-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file cir-model-0.2.0.tar.gz.

File metadata

  • Download URL: cir-model-0.2.0.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.12

File hashes

Hashes for cir-model-0.2.0.tar.gz
Algorithm Hash digest
SHA256 3ed5274ef952361945e444beb35e386707bc367e632a949cf6ddce65258a0aa2
MD5 14c3b14a3009399fd140856498981fd0
BLAKE2b-256 409e595c5c70dd0a1382083df9e484a430288fdbaf3ff016d659037002540050

See more details on using hashes here.

File details

Details for the file cir_model-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: cir_model-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.12

File hashes

Hashes for cir_model-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fb3f24b580f66156b43d26d1cf8d0f8e95439d554246fb32334b4bd4e44327e9
MD5 fe9a0eceba460ecd1a826179e08839f8
BLAKE2b-256 7488dcbe29ae755d01c507e6fbd91cd19089ec5243ddaeb29caa71c40089c86c

See more details on using hashes here.

Supported by

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