User guide¶
The guide explains how zeki works and how to use each part of it. Every example on these pages is run as a test against the current release.
Concepts
- Collections: what a collection is, and the names for its parts.
- Value types: constants, arrays and jagged values, and their kinds.
- Lazy and eager: how zeki builds a model, and when it evaluates.
Using zeki
- Building collections: from DataFrames, functions, existing arrays, or a row at a time.
- Expressions: arithmetic, combining collections, maths functions, conditionals and lengths.
- Dependency and copulas: correlating values, and how zeki keeps everything built from them consistent.
- Reading values out: to NumPy, Polars, pandas or plain Python.
Going further
- Performance: why zeki is fast, and how to keep a model fast.
- Example model: a complete capital model built with zeki.