API Reference

This section is useful only if you want to modify or extend the code. As a user, you don’t need to know these details.

Some of the inconsistencies you might see are a consequence of:

• A lot of this codebase was ported from Python 2.

• Much of the original codebase was geared towards long-running research experiments.

• The codebase itself evolved intermittently as I explored different ideas.

I am still in the process of refactoring.

Here’s a list of the various packages to begin exploring:

compactem	The root package.
compactem.core	Package for the core sampling and optimization related codes.
compactem.oracles	Various oracle learners.
compactem.model_builder	Package for the model builder base class, as well as implementations.
compactem.utils	Various utility functions are grouped here, e.g., data format checks.

There’s also a Module Index for reference.