API reference¶

This reference is generated from the source code and its docstrings. For an explanation-first introduction, start with the user guide.

The recommended import is import polder as pld. The most commonly used names are re-exported at the top level of the package, so you can reach them as pld.<name>.

Module map¶

• Creation: build arrays from values and labels, or from a single frame.
• Conversion: move an array between implementations.
• The protocol: the FrameLabeledArray protocol that your code targets.
• Eager implementation: the array-backed EagerFrameLabeledArray.
• Lazy implementation: the DataFrame-backed LazyFrameLabeledArray.
• Operations: unary elementwise functions and alignment.
• Configuration: global settings such as automatic alignment.