Update README images

[zhangh43]

Summary by CodeRabbit

• Documentation
  • Benchmark documentation updated with specific hardware instance specifications and improved clarity on working-set capacity conditions.
  • Test descriptions refined with updated terminology to enhance emphasis on reproducibility and fair comparison methodology.
  • Minor textual improvements for clearer communication of test parameters and conditions.

[coderabbitai]

Walkthrough

README.md benchmark section updated with specific AWS EC2 infrastructure details (i4i.4xlarge instance, 16 vCPUs, 128 GB RAM, local NVMe) and clarified working-set condition terminology. Minor wording adjustments improve grammar and clarity throughout the benchmarking documentation.

Changes

Cohort / File(s)	Change Summary
Documentation Updates README.md	Benchmark section refined with specific AWS instance details and hardware specifications; test description wording adjusted from "executed" to "conducted"; working-set condition clarified; minor grammar fix in concluding benchmark sentence

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• eloqdata/eloqdoc#249: Modifies README benchmark and architecture sections; overlaps with this PR's refinement of benchmark infrastructure details and wording.

Suggested reviewers

• lzxddz

Poem

🐰 Benchmarks now shine with crystal clarity,
AWS specs noted, no vaguery,
Cache thresholds defined so true,
Documentation polished fresh and new! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Title Check	⚠️ Warning	The pull request title is "Update README images," but the raw summary indicates that the changes consist entirely of text and content modifications to README.md: specific instance details were added to the benchmark section, test description wording was adjusted, and a minor copy edit was made to a concluding sentence. There is no mention of any image updates in the provided summary. This creates a meaningful disconnect between the title, which suggests visual asset changes, and the actual changes documented, which are text-only modifications.	The title should be revised to accurately reflect the actual changes made, such as "Update README benchmark and test documentation" or "Clarify benchmark section details and fix copy in README" to properly describe the text and content updates that comprise this changeset.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7ed174d and dd1d4cc.

⛔ Files ignored due to path filters (3)

• images/eloqdocatlas16c150mro.jpg is excluded by !**/*.jpg
• images/eloqdocatlasfull16cro.jpg is excluded by !**/*.jpg
• images/eloqdocatlasfull16crw.jpg is excluded by !**/*.jpg

📒 Files selected for processing (1)

• README.md (2 hunks)

🧰 Additional context used

🪛 LanguageTool

README.md

[locale-violation] ~126-~126: The phrase ‘in future’ is British English. Did you mean: “in the future”?
Context: ...e will publish more detailed benchmarks in future. --- ## Quick Start ### Try EloqD...

(IN_FUTURE)

🔇 Additional comments (2)

README.md (2)

91-91: Excellent addition of specific infrastructure and methodology details.

The new benchmark description provides concrete AWS instance details and clarifies the working-set condition terminology. This significantly improves transparency and helps readers understand the test environment and fairness controls.

---

126-126: Now I need to examine the README file to determine the project's English language conventions:

Based on my verification:

The review comment is reasonable but overstated—"in future" is valid British English, not an error.

An American would say "in the future", whereas a Brit would likely say "in future" (with no article). The phrase "in future" is used a lot in British English, but very rare in American English. It is used to mean starting now and into the future. Both are grammatically correct but differ by region.

The LanguageTool IN_FUTURE flag suggests standardizing to American English, which aligns with industry practice. GitHub's style guide recommends following standard American English punctuation rules. However, without confirming your project's established English variant preference (American vs. British), the change is optional, not mandatory.

The review comment should clarify: this is a style consistency recommendation for American English, not a grammatical correction. The prior fix (removing "a" before "detailed benchmarks") was correct; the "in future" → "in the future" change is a separate stylistic preference.

---

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.}