Skip to main content

Scikit-learn estimators based on projection pursuit

Project description

Projection Pursuit

Build Status Coverage Status Downloads

Documentation, How it works.

This repository is home to a couple scikit-learn-compatible estimators based on Jerome Friedman's generalizations[1] of his and Werner Stuetzle's Projection Pursuit Regression algorithm[2][3]. A regressor capable of multivariate estimation and dimensionality reduction and a univariate classifier based on regression to a one-hot multivariate representation are included.

This repository is also meant to serve as a fairly pared-down example of how to use Github Actions, Coveralls, Sphinx, PyTest, how to deploy to PyPI and Github Pages, and how to create a Scikit-Learn Estimator that passes the sklearn checks and follows the PEP 8 style standard.

Installation and Usage

The package by itself comes with a single module containing the estimators. Before installing the module you will need numpy, scipy, scikit-learn, and matplotlib. To install the module execute:

pip install projection-pursuit

or

$ python setup.py install

If the installation is successful, you should be able to execute the following in Python:

>>> from skpp import ProjectionPursuitRegressor
>>> estimator = ProjectionPursuitRegressor()
>>> estimator.fit(np.arange(10).reshape(10, 1), np.arange(10))

Sphinx is run via continuous integration to generate the API.

For a few usage examples, see the examples and benchmarks directories. For an intuition of what the learner is doing, try running viz_training_process.py. For comparisons to other learners and an intuition of why you might want to try PPR, try the benchmarks. For a deep dive in to the math and an explanation of exactly how and why this works, see math.pdf.

References

  1. Friedman, Jerome. (1985). "Classification and Multiple Regression Through Projection Pursuit." http://www.slac.stanford.edu/pubs/slacpubs/3750/slac-pub-3824.pdf
  2. Hastie, Tibshirani, & Friedman. (2016). The Elements of Statistical Learning 2nd Ed., section 11.2.
  3. (2017) Projection pursuit regression https://en.wikipedia.org/wiki/Projection_pursuit_regression

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

projection_pursuit-1.1.tar.gz (12.1 kB view details)

Uploaded Source

Built Distribution

projection_pursuit-1.1-py3-none-any.whl (12.9 kB view details)

Uploaded Python 3

File details

Details for the file projection_pursuit-1.1.tar.gz.

File metadata

  • Download URL: projection_pursuit-1.1.tar.gz
  • Upload date:
  • Size: 12.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for projection_pursuit-1.1.tar.gz
Algorithm Hash digest
SHA256 2c88a2f2a1b649a300882313c091d630fff5acd1044e70ee988d03926c33e439
MD5 44de545dc82d626c9d92e755bf0bc364
BLAKE2b-256 8d95ea8d27193c42968528b014a60eff6bb931c93ac8e4ee57e4d6d5d7ed7d09

See more details on using hashes here.

File details

Details for the file projection_pursuit-1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for projection_pursuit-1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e6bb094f1db35b76654bd7a1105edd3e20ed1c2bf5abe47d707d77dc346a0f72
MD5 82b35286cc7909f1cebf165dd8764dfa
BLAKE2b-256 176b482e9160cb684d022a78b37247a9592a563a939fdbc1fc21a1d0272b26dd

See more details on using hashes here.

Supported by

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