API reference¶
The public API of the zeki package, imported as import zeki as zk. Each page is generated from
the docstrings in the package source.
| Page | Covers |
|---|---|
| Collection | zk.Collection: the lazy collection, and everything you can do with it |
| Collected | zk.Collected and zk.collect_all: evaluated values, and reading them out |
| Schemas | zk.Dims, zk.Dim, zk.ValueColumns and the value types: zk.FloatA and the rest |
| Expressions | zk.dim, zk.value, zk.when, group-bys, and dimension rows |
| Functions | zk.concat, zk.min, zk.max, zk.clamp, zk.float and zk.int |
| Copulas | zk.Copula, zk.correlate, zk.Context and copula bookkeeping |
| Settings | Threads, the result cache and timings |
| Engine | zk.engine: the engine underneath collections, built directly from float arrays |
Diagrams¶
The whole API is also drawn as railroad diagrams, in the manner of json.org's: how each call is written, and what it gives. Open the API diagrams, or download them as one SVG.