API ReferenceΒΆ
The unit_averaging
package has two principal modules:
unit_averaging.averager that contains averaging strategies.
unit_averaging.focus_function that contains focus function classes.
For convenience, all public classes and functions from both modules are exposed at the package level, and you can import everything directly from the package without referencing individual modules:
from unit_averaging import OptimalUnitAverager
Averager classes:
Class |
Description |
---|---|
Abstract base class. Subclass and implement |
|
Assigns all weight to the target unit ( |
|
Equal weights for all units ( |
|
MSE-optimal weights (agnostic and with prior restrictions). |
Focus function classes:
Class |
Description |
---|---|
Abstract base class. Subclass and implement |
|
Convenience class for creating focus functions from callables. |
See also
In addition to this API reference, also see:
Background about unit averaging for a quick reference on the theory of unit averaging.
The tutorials to see the code in action.