Skip to content

README: prominent HF Space + Dataset callouts#1

Merged
VibeCodingScientist merged 1 commit into
mainfrom
readme-hf-callouts
May 22, 2026
Merged

README: prominent HF Space + Dataset callouts#1
VibeCodingScientist merged 1 commit into
mainfrom
readme-hf-callouts

Conversation

@VibeCodingScientist
Copy link
Copy Markdown
Collaborator

@VibeCodingScientist VibeCodingScientist commented May 22, 2026

Summary

  • Adds a visible HF Space callout right after the description, before the Quickstart fold — points readers to the interactive leaderboard before they reach for git clone.
  • Adds a parallel HF Dataset callout with the load_dataset(...) snippet.

Both badges were already in the badge row at the top, but they're easy to miss. The callouts give the HF resources a clear above-the-fold entry point.

Test plan

Co-authored with Claude Code.

Summary by CodeRabbit

  • Documentation
    • Added link to interactive leaderboard on HuggingFace Space
    • Added dataset documentation with instructions for loading trial-level compliance labels

Review Change Stack

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 22, 2026

Caution

Review failed

Pull request was closed or merged during review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 83b1c403-1f5d-469a-ae21-41cdc8d307cf

📥 Commits

Reviewing files that changed from the base of the PR and between 6a9bd9d and 78bd9bd.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

README.md now documents an interactive leaderboard hosted on HuggingFace Spaces and provides dataset access instructions, showing how to load trial-level compliance labels directly via the Hugging Face load_dataset API.

Changes

Documentation Updates for Resources

Layer / File(s) Summary
Interactive leaderboard and dataset documentation
README.md
README.md adds a new section documenting the interactive leaderboard (HuggingFace Space) and dataset reference with code snippet for loading trial-level compliance labels.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A leaderboard gleams, a dataset takes flight,
HuggingFace spaces now shine ever bright!
Load the compliance with one simple call,
load_dataset whispers—the friendliest of all. 🌟

🚥 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 accurately describes the main change: adding prominent callouts for HuggingFace Space and Dataset in the README, which is the primary focus of the PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch readme-hf-callouts

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

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

@VibeCodingScientist VibeCodingScientist merged commit 19de870 into main May 22, 2026
0 of 3 checks passed
@VibeCodingScientist VibeCodingScientist deleted the readme-hf-callouts branch May 22, 2026 07:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants