Skip to content
Parameter space dimension reduction toolbox
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Demos
Reproducibility
Tutorials
checkder
docs
psdr
tests
.coveragerc
.gitattributes
.gitignore
.readthedocs.yml
.travis.yml
LICENSE
README.md
demo.py
eqn1.png
setup.py
shadow.png

README.md

PSDR: Parameter Space Dimension Reduction Toolbox

Documentation Status Build Status Coverage Status

Author: Jeffrey M. Hokanson, Postdoctoral Fellow at the University of Colorado Boulder (jeffrey@hokanson.us)

Introduction

Given a function mapping some subset of an m-dimensional space to a scalar value

f: D subset R^m to R

parameter space dimension reduction seeks to identify a low-dimensional manifold of the input along which this function varies the most. Frequently we will choose to use a linear manifold and consequently identify linear combinations of input variables along which the function varies the most.

We emphasize that this library is for parameter space dimension reduction as the term 'dimension reduction' often appears in other contexts. For example, model reduction is often referred to as dimension reduction because it reduces the state-space dimension of a set of differential equations, yielding a smaller set of differential equations.

Simple example

One basic use of the library is to identify an active subspace using the outer product of gradients:

import psdr, psdr.demos
fun = psdr.demos.Borehole()    # load a test problem
X = fun.domain.sample(1000)    # sample points from the domain with uniform probabilty
grads = fun.grad(X)            # evaluate the gradient at the points in X
act = psdr.ActiveSubspace()    # initialize a class to find the Active Subspace
act.fit(grads)                 # estimate the active subspace using these Monte-Carlo samples
print(act.U[:,0])              # print the most important linear combination of variables

>>> array([ 9.19118904e-01, -2.26566967e-03,  2.90116247e-06,  2.17665629e-01,
        2.78485430e-03, -2.17665629e-01, -2.21695479e-01,  1.06310937e-01])

We can then create a shadow plot showing the projection of the input to this function onto a one-dimensional subspace spanned by the important linear combination identified above

import matplotlib.pyplot as plt
fX = fun(X)                    # evaluate the function at the points X
act.shadow_plot(X, fX)         # generate the shadow plot
plt.show()                     # draw the results

A shadow plot for the borehole function

We say this function is has low-dimensional structure since the output of the function is well described by the value of this one linear combination of its input parameters.

Documentation

For further documentation, please see our page on Read the Docs: Documentation.

Contributing

I welcome contributions to this library, particularly of test functions similar to those in psdr.demos. Please submit a pull request along with unit tests for the proposed code. If you are submitting a complex test function that requires calling code outside of Python, please submit a Docker image along with a docker file generating that image (see the OpenAeroStruct demo function for an example of how to do this).

Contributors

  • Zach Grey
  • Lakshya Sharma
You can’t perform that action at this time.