API Reference
Auto-generated from the docstrings in the openavmkit package. Every module that
defines at least one public function or class gets a page here.
New to the library? Start with Getting Started and The Basics — this section is a reference, not a tutorial.
Core
The main pipeline and analysis modules.
| Module | What it covers |
|---|---|
pipeline |
End-to-end orchestration of a run |
data |
Loading, merging, and the SalesUniversePair |
cleaning |
Fill rules and data validation |
filters |
The filter DSL |
calculations |
The calc expression language |
inference |
Spatial inference |
condos |
Condo modeling pathway |
modeling |
Model primitives and DataSplit |
model_runner |
Running and comparing model groups |
projection |
Projections |
time_adjustment |
Sale-date time adjustment and market indices |
income |
Income approach |
ratio_study |
IAAO ratio studies |
horizontal_equity_study |
Horizontal equity |
vertical_equity_study |
Vertical equity / VEI |
sales_scrutiny_study |
Anomalous-sale detection |
sales_chasing |
Sales-chasing detection |
shap_analysis |
SHAP contributions |
area_stats |
Area-level statistics |
reports |
PDF and HTML report generation |
checkpoint |
Caching and checkpoints |
Cloud
Remote storage backends: cloud, base,
azure, huggingface, sftp.
Synthetic
Synthetic data generation for testing and demos:
synthetic, basic,
city, generate.
Utilities
Supporting helpers — geometry, enrichment sources, formatting, and stats:
geometry, census,
openstreetmap, overture,
dem, clustering,
somers, stats,
settings, format,
plotting, excel,
cache, timing,
assertions, data,
modeling.