mirror of
https://github.com/open-jarvis/OpenJarvis.git
synced 2026-07-30 02:42:16 +00:00
Jon Saad-FalconandClaude Opus 4.6
f75afefcfb
Sets up a complete documentation website with 7 navigable sections (Home, Getting Started, User Guide, Architecture, API Reference, Deployment, Development), light/dark mode, search, code copy, and Mermaid diagram support. API reference pages use mkdocstrings to auto-generate docs from source docstrings. GitHub Actions workflow deploys to GitHub Pages on push to main. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1.5 KiB
1.5 KiB
API Reference
This section contains the auto-generated API reference for the OpenJarvis Python package. Documentation is extracted directly from the source code docstrings using mkdocstrings.
Each page documents a major module of the framework, including abstract base classes, concrete implementations, and utility functions.
Modules
| Module | Description |
|---|---|
| SDK | High-level Jarvis class and MemoryHandle proxy |
| Core | Registries, types, configuration, and event bus |
| Engine | Inference engine ABC and backends (Ollama, vLLM, llama.cpp, SGLang, Cloud) |
| Agents | Agent ABC and implementations (Simple, Orchestrator, OpenClaw, Custom) |
| Memory | Memory backend ABC and implementations (SQLite, FAISS, ColBERT, BM25, Hybrid) |
| Tools | Tool ABC, executor, and built-in tools (Calculator, Think, Retrieval, LLM, FileRead) |
| Intelligence | Heuristic router and model catalog |
| Learning | Router policies, reward functions, and trace-driven learning |
| Traces | Trace storage, collection, and analysis |
| Telemetry | Telemetry storage, aggregation, and instrumented wrappers |
| Benchmarks | Benchmark ABC, suite runner, latency and throughput benchmarks |
| Server | FastAPI application, OpenAI-compatible routes, and Pydantic models |