add usage guide and examples for relational_fusion

[Rohank3]

Fixes #19

The document is located at docs/usage/relational_fusion.md and includes:

CLI Usage: Quick start commands for benchmarking and regression.
Python API Guide: Detailed explanation of the generate and solve functions.
Concrete Examples: Real input/output samples verified against the project's deterministic generators.
End-to-End Script: A runnable demo script that users can copy-paste to verify their local setup.
Algorithm Overview: A high-level explanation of the hash-join and aggregation strategy, including its SQL equivalent.
Native Backend Instructions: How to build and compare performance with the C++ implementation.

Summary by CodeRabbit

• Documentation
  • Added a comprehensive guide for the relational_fusion task with CLI and Python API instructions.
  • Includes an end-to-end example script demonstrating workload generation, invocation, printed metrics, and sample regression output.
  • Documents expected input/output formats and programmatic benchmarking (with default benchmark sizing).
  • Notes an optional native C++ backend that is used automatically when available and where to find build details.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: fcdb33ee-8ddf-44ab-ba87-844b89cb847f

📥 Commits

Reviewing files that changed from the base of the PR and between 3f88449 and f06ba8f.

📒 Files selected for processing (1)

• docs/usage/relational_fusion.md

✅ Files skipped from review due to trivial changes (1)

• docs/usage/relational_fusion.md

---

Walkthrough

Added docs/usage/relational_fusion.md, a new documentation page describing the relational_fusion task: CLI usage, Python API (generate, solve), input/output formats, an end-to-end demo with regression check, benchmarking invocation, and native C++ backend notes.

Changes

Cohort / File(s)

Summary

Documentation docs/usage/relational_fusion.md

New guide documenting the relational_fusion task: CLI and Python API usage (including generate(row_count, seed) and solve(payload)), input/output formats and expected fields (left_rows, right_rows, join_rows, aggregate), example end-to-end script with regression assert, benchmarking invocation (chuck.benchmarks.relational_fusion.run()), default benchmark size (row_count=40_000), and optional native C++ backend notes (see NATIVE_BINDINGS.md).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested labels

accepted-30

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'add usage guide and examples for relational_fusion' directly matches the PR's primary change: adding comprehensive documentation with examples.
Linked Issues check	✅ Passed	The PR fulfills all requirements from issue #19: creates docs/usage/relational_fusion.md with example scripts, input/output samples, and usage documentation.
Out of Scope Changes check	✅ Passed	All changes are directly scoped to issue #19: the new documentation file and commits removing referenced images are all related to the usage guide.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/usage/relational_fusion.md`:
- Around line 126-132: The fenced code block in docs/usage/relational_fusion.md
that contains the terminal output (the block starting with the three backticks
before "Left rows  : 128") lacks a language identifier; update that block
delimiter from ``` to ```text so the output is rendered/accessed properly (e.g.,
change the opening fence for the "Left rows / Right rows / Join rows / Aggregate
/ ✓ Output matches regression baseline" snippet to ```text).

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: f72f9636-cdfa-449f-b2a8-028018ad03d7

📥 Commits

Reviewing files that changed from the base of the PR and between a302e5f and ff8f492.

📒 Files selected for processing (1)

• docs/usage/relational_fusion.md

[Aaryan-Dadu]

Could you please share the demo screenshot for the script

[Aaryan-Dadu]

The PR is in right direction, please reolve the above comments.

[Rohank3]

The PR is in right direction, please reolve the above comments.

yes working on them

[Aaryan-Dadu]

Please remove this file from here

[Rohank3]

i have linked the file as screeshot through relative link, you u want me to update to url.
i did with relative as it would be more safer and easier way

[Aaryan-Dadu]

I made the changes I wanted.

[Aaryan-Dadu]

Thanks for the PR!

[Aaryan-Dadu]

I am little less satisfied with the overall PR that's why will be deducting 5 points for quality and extensive use of AI.