README / README.md
ockhamsh's picture
Drop catalogs table; HF dataset listing is canonical
b6ef58c verified
|
Raw
History Blame Contribute Delete
1.75 kB
---
title: README
emoji: πŸ“‰
colorFrom: indigo
colorTo: gray
sdk: static
pinned: false
---
<h1 align="center">PARSIMONY</h1>
<p align="center"><em>Pre-built searchable indexes of financial and economic data series.</em></p>
---
Each dataset here is a drop-in catalog β€” a parquet of series metadata plus a FAISS embedding index β€” consumed by the matching [parsimony](https://github.com/ockham-sh/parsimony) connector to resolve natural-language queries like *"swiss policy rate"* or *"US 10-year yield"* to a provider-native series ID, without hitting the upstream provider.
These datasets are not meant to be browsed directly. Install the relevant connector from [parsimony-connectors](https://github.com/ockham-sh/parsimony-connectors) β€” its `<provider>_search` function pulls the catalog on first use and caches it locally.
## Anatomy of a catalog
- `entries.parquet` β€” one row per series with provider ID, title, units, frequency.
- `embeddings.faiss` β€” dense vector index over titles and descriptions for semantic lookup.
- `meta.json` β€” provider, snapshot timestamp, embedding model, row counts.
Catalogs are pulled on-demand by the matching connector and cached locally. No API keys required to read the indexes β€” keys are only needed when you fetch the actual series from the upstream provider.
## Links
- **Kernel** β€” [github.com/ockham-sh/parsimony](https://github.com/ockham-sh/parsimony)
- **Connectors** β€” [github.com/ockham-sh/parsimony-connectors](https://github.com/ockham-sh/parsimony-connectors)
- **Docs** β€” [docs.parsimony.dev](https://docs.parsimony.dev)
- **PyPI** β€” [`parsimony-core`](https://pypi.org/project/parsimony-core/)
Maintained by [Ockham](https://github.com/ockham-sh) Β· Apache 2.0