| diataxis | explanation | ||||||
|---|---|---|---|---|---|---|---|
| tags |
|
RecSys is a modular recommendation suite you can run locally or in production. The docs are organized by what you want to do and by persona entry points so you can reach the next needed page in ≤2 clicks.
- Developer (integration + deployment) → Developers hub
- Business representative (evaluation + procurement) → For businesses
- SRE / operator (reliability + runbooks) → Operations
- Recommendation engineer (signals + evaluation) → RecSys engineering hub
- Technical writer / docs lead (quality + consistency) → Technical writer persona
Pick one goal and follow the linked page end-to-end.
- Get a ranked list from the API: Tutorial: Quickstart (minimal)
- Run a credible 1-surface pilot: How-to: minimum pilot setup (one surface)
- Understand the architecture and data flow: How it works: architecture and data flow
- A serving API (
recsys-service) you call from your product to get ranked items. - A pipeline (
recsys-pipelines) that builds signals/artifacts and publishes a manifest for safe shipping and rollback. - An evaluation toolchain (
recsys-eval) to validate data joins and compute decision-ready metrics.
If you are evaluating RecSys for your organization:
- Start here: Business representative hub
- Understand licensing: Licensing
- Decide and proceed: Pricing and ordering
Procurement artifacts:
- What performance you should expect: Benchmarks (buyer-facing)
- How to reproduce baseline numbers: Baseline benchmarks (ops)
- What RecSys does not promise: Guarantees and non-goals
- Overview and checklist: Security, privacy, compliance