docs(graphrag-sdk): expand docs with benchmarks, crash-safety, and examples table#516
docs(graphrag-sdk): expand docs with benchmarks, crash-safety, and examples table#516gkorland wants to merge 3 commits into
Conversation
…amples table - Add Documentation links table (getting-started, architecture, configuration, strategies, providers, benchmark) - Add benchmark-leading accuracy callout with link to docs/benchmark.md - Document crash-safety (rollforward cutover) and concurrency knobs for incremental updates - Add code example for return_context=True (cited answers) - Convert examples list into a table linking all example files - Clarify schema vs. ontology terminology Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Warning Review limit reached
Next review available in: 57 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Improves the graphrag-sdk documentation page to better match upstream GraphRAG-SDK docs/README, adding clearer navigation, performance/benchmark context, and more actionable usage guidance.
Changes:
- Adds a structured “Resources” section with a guide links table plus a benchmark-leading accuracy callout.
- Expands incremental update documentation with cost model details, crash-safety behavior, and concurrency knobs.
- Adds a
return_context=Trueretrieval-trail snippet and converts the examples list into a linked table.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| genai-tools/graphrag-sdk.md | Expands GraphRAG-SDK docs with guide links, benchmark callout, crash-safety/concurrency notes, retrieval-trail example, and an examples table. |
| .wordlist.txt | Adds “backfill” to the spellcheck allowlist. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | 3 | [Custom Strategies](https://github.com/FalkorDB/GraphRAG-SDK/blob/main/graphrag_sdk/examples/03_custom_strategies.py) | The benchmark-winning pipeline, ready to drop in | | ||
| | 4 | [Custom Provider](https://github.com/FalkorDB/GraphRAG-SDK/blob/main/graphrag_sdk/examples/04_custom_provider.py) | Plug in any LLM or embedder behind a clean interface | | ||
| | 5 | [Notebook Demo](https://github.com/FalkorDB/GraphRAG-SDK/blob/main/graphrag_sdk/examples/05_notebook_demo.ipynb) | An interactive walkthrough that shows the provenance trail | | ||
| | 7 | [Incremental Updates](https://github.com/FalkorDB/GraphRAG-SDK/blob/main/graphrag_sdk/examples/07_incremental_updates.py) | `update`, `delete_document`, and `apply_changes` for CI-driven graph syncs | |
Summary
Improves the GraphRAG-SDK docs page by aligning it with the upstream FalkorDB/GraphRAG-SDK README and docs, filling gaps and clarifying terminology.
Changes
docs/benchmark.md(top score on GraphRAG-Bench)max_concurrency,update_concurrency) for incremental updatesreturn_context=Truefor retrieving the citation/retrieval trailGraphSchemaAPI, with a note on when 'ontology' applies conceptuallyTesting
Documentation-only change; reviewed manually for markdown correctness and verified all links against the upstream repo.
Memory / Performance Impact
N/A
Related Issues
N/A