RecSys is an auditable recommendation system suite with deterministic ranking and versioned ship/rollback.
This repository contains a complete, production-oriented recommendation system stack:
- recsys-service (
api/): low-latency HTTP API for serving recommendations - recsys-algo (
recsys-algo/): deterministic ranking core used by the service - recsys-pipelines (
recsys-pipelines/): offline pipelines that build versioned artifacts - recsys-eval (
recsys-eval/): evaluation tooling for regression + experimentation
All the hosted documentation lives under /docs, rendered with MkDocs using mkdocs.yml.
You can access this documentation in several ways:
- Visit
https://recsys.app. - Visit
https://github.com/aatuh/recsysand browse the/docsdirectory. - Run
make docs-serveand openhttp://localhost:8001.
Start here:
docs/index.md- Tutorial:
docs/tutorials/local-end-to-end.md - Suite architecture:
docs/explanation/suite-architecture.md
Module docs in MkDocs:
- recsys-algo:
docs/recsys-algo/index.md - recsys-pipelines:
docs/recsys-pipelines/docs/index.md - recsys-eval:
docs/recsys-eval/docs/index.md
- Tags
recsys-suite/vX.Y.Zpublish/X.Y.Z/and update/latest/. - Default branch publishes
/dev/. - The site root (
/) serves the contents of/latest/(falls back to/dev/before the first tag; no URL change). - GitHub Pages source is GitHub Actions (Settings → Pages).
See the canonical licensing pages in: