Skip to main content

The ace Package

ace is an implementation of the Alternating Conditional Expectation (ACE) algorithm [Breiman85], which can be used to find otherwise difficult-to-find relationships between predictors and responses and as a multivariate regression tool.

The code for this project, as well as the issue tracker, etc. is hosted on GitHub. The documentation is hosted at http://partofthething.com/ace.

What is it?

ACE can be used for a variety of purposes. With it, you can:

  • build easy-to-evaluate surrogate models of data. For example, if you are optimizing input parameters to a complex and long-running simulation, you can feed the results of a parameter sweep into ACE to get a model that will instantly give you predictions of results of any combination of input within the parameter range.

  • expose interesting and meaningful relations between predictors and responses from complicated data sets. For instance, if you have survey results from 1000 people and you and you want to see how one answer is related to a bunch of others, ACE will help you.

The fascinating thing about ACE is that it is a non-parametric multivariate regression tool. This means that it doesn’t make any assumptions about the functional form of the data. You may be used to fitting polynomials or lines to data. Well, ACE doesn’t do that. It uses an iteration with a variable-span scatterplot smoother (implementing local least squares estimates) to figure out the structure of your data. As you’ll see, that turns out to be a powerful difference.

Installing it

ace is available in the Python Package Index, and can be installed simply with the following.

On Linux:

sudo pip install ace

On Windows, use:

pip install ace

or use the GUI installer.

Directly from source:

git clone git@github.com:partofthething/ace.git
cd ace
python setup.py install

You can verify that the installation completed successfully by running the automated test suite in the install directory:

python -m unittest discover -bv

Using it

To use, get some sample data:

from ace.samples import wang04
x, y = wang04.build_sample_ace_problem_wang04(N=200)

and run:

from ace import model
myace = model.Model()
myace.build_model_from_xy(x, y)
myace.eval([0.1, 0.2, 0.5, 0.3, 0.5])

For some plotting (matplotlib required), try:

from ace import ace
ace.plot_transforms(myace.ace, fname = 'mytransforms.pdf')
myace.ace.write_transforms_to_file(fname = 'mytransforms.txt')

Note that you could alternatively have loaded your data from a whitespace delimited text file:

myace.build_model_from_txt(fname = 'myinput.txt')

Demo

A clear demonstration of ace is available in the Sample ACE Problems section.

Other details

This implementation of ACE isn’t as fast as the original FORTRAN version, but it can still crunch through a problem with 5 independent variables having 1000 observations each in on the order of 15 seconds. Not bad.

ace also contains a pure-Python implementation of Friedman’s SuperSmoother [Friedman82], the variable-span smoother mentioned above. This can be useful on its own for smoothing scatterplot data.

History

The ACE algorithm was published in 1985 by Breiman and Friedman [Breiman85], and the original FORTRAN source code is available from Friedman’s webpage.

Motivation

Before this package, the ACE algorithm has only been available in Python by using the rpy2 module to load in the acepack package of the R statistical language. This package is a pure-Python re-write of the ACE algorithm based on the original publication, using modern software practices. This package is slower than the original FORTRAN code, but it is easier to understand. This package should be suitable for medium-weight data and as a learning tool.

For the record, it is also quite easy to run the original FORTRAN code in Python using f2py.

About the Author

This package was originated by Nick Touran, a nuclear engineer specializing in reactor physics. He was exposed to ACE by his thesis advisor, Professor John Lee, and used it in his Ph.D. dissertation to evaluate objective functions in a multidisciplinary design optimization study of nuclear reactor cores [Touran12].

License

This package is released under the MIT License, reproduced here.

References

[Breiman85] (1,2)

L. BREIMAN and J. H. FRIEDMAN, “Estimating optimal transformations for multiple regression and correlation,” Journal of the American Statistical Association, 80, 580 (1985). [Link1]

[Friedman82]

J. H. FRIEDMAN and W. STUETZLE, “Smoothing of scatterplots,” ORION-003, Stanford University, (1982). [Link2]

[Wang04]

D. WANG and M. MURPHY, “Estimating optimal transformations for multiple regression using the ACE algorithm,” Journal of Data Science, 2, 329 (2004). [Link3]

[Touran12]

N. TOURAN, “A Modal Expansion Equilibrium Cycle Perturbation Method for Optimizing High Burnup Fast Reactors,” Ph.D. dissertation, Univ. of Michigan, (2012). [The Thesis]

Metadata

Release files for ace 0.3.post1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ace 0.3.post1
File Size Uploaded
ace-0.3.post1.tar.gz 17.2 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for ace 0.3.post1
File Interpreter ABI Platform
ace-0.3.post1-py3-none-any.whl Python 3 none any Details
ace-0.3.post1-py2-none-any.whl Python 2 none any Details

Total release size: 162.8 kB

Release files / ace-0.3.post1.tar.gz

Download URL ace-0.3.post1.tar.gz
Size 17.2 kB
Tags Source
SHA-256 checksum
How to use checksums
9ff0c8f158c5a7f5dc1ccc32e16e5e6e9575ae6867e8f948ebb0c0ad0400eab1
BLAKE2b-256 checksum
How to use checksums
ec013dacd9c949c758b6d1c7f8af90e34278c1d0480b4106719062de1e44674d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / ace-0.3.post1-py3-none-any.whl

Download URL ace-0.3.post1-py3-none-any.whl
Size 72.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fd2e50f7507a8a94ede91bd1b91ae82768afba22038a98304fa139a10ada76b6
BLAKE2b-256 checksum
How to use checksums
7e35062eb894595695b50b99b1ff9dd90c2d0fbc5dc8bceda9f0d39ccf681aff
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / ace-0.3.post1-py2-none-any.whl

Download URL ace-0.3.post1-py2-none-any.whl
Size 72.8 kB
Tags Python 2
SHA-256 checksum
How to use checksums
99846bb6fb8ddf1f98806dfda3417302e95af5ba5cb8460d88ed582e1f3fd0af
BLAKE2b-256 checksum
How to use checksums
d9feda264c995684aa8848fa8181fdbfce66bcf7abba34bb8e0711a9c748a638
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.3

2 release files

0.3.2

2 release files

This release

0.3.post1 This release

3 release files

0.3

0.2

3 release files

0.1

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page