Skip to content

Mention hf datasets sql in the datasets DuckDB and Data Studio docs#2658

Open
davanstrien wants to merge 1 commit into
mainfrom
datasets-sql-hints
Open

Mention hf datasets sql in the datasets DuckDB and Data Studio docs#2658
davanstrien wants to merge 1 commit into
mainfrom
datasets-sql-hints

Conversation

@davanstrien

@davanstrien davanstrien commented Jul 20, 2026

Copy link
Copy Markdown
Member

The hf CLI ships hf datasets sql (and hf datasets parquet), but the datasets docs never mention them: the DuckDB section only describes installing the standalone DuckDB CLI and manually configuring token secrets, and the SQL Console pages only cover the browser. Anyone (or any agent) landing on these pages gets sent down the slower path when a single command already does the job.

This PR adds short pointers — one tip or one sentence per page, each linking to the CLI reference rather than duplicating it:

  • datasets-duckdb.md — tip with a runnable example (reusing the page's existing ibm/duorc demo query), noting automatic auth and --format json
  • datasets-duckdb-auth.md — tip that hf datasets sql configures the token secret automatically, so the manual CREATE SECRET steps can be skipped
  • datasets-viewer-sql-console.md — extends the existing "DuckDB locally" tip with the CLI alternative
  • data-studio.md — CLI alternative in the "Run SQL queries" section; hf datasets parquet added next to the parquet-list API under "Programmatic access"

Verified against hf CLI v1.23.0: the example query runs as written, auth is injected automatically from the logged-in token, and both CLI-reference anchors resolve.

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only edits with no runtime, auth, or API behavior changes.

Overview
Hub dataset docs now point readers at hf datasets sql and hf datasets parquet instead of only describing the browser SQL Console, standalone DuckDB CLI, and Hub API.

data-studio.md adds a CLI option next to the SQL Console guide and documents hf datasets parquet / hf datasets sql under programmatic Parquet access. datasets-duckdb.md adds a tip with a runnable ibm/duorc example, auto-auth, and --format json. datasets-duckdb-auth.md notes that hf datasets sql skips manual DuckDB secret setup. datasets-viewer-sql-console.md extends the existing local DuckDB tip with the hf CLI alternative. All links target the huggingface_hub CLI reference rather than duplicating command docs.

Reviewed by Cursor Bugbot for commit 30fe360. Bugbot is set up for automated code reviews on this repo. Configure here.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@HuggingFaceDocBuilderDev

Copy link
Copy Markdown

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@davanstrien

Copy link
Copy Markdown
Member Author

cc @Wauplin @lhoestq for viz

@julien-c julien-c left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good idea (it's also there https://huggingface.co/docs/huggingface_hub/main/en/guides/cli#list-parquet-urls but can't hurt to also have it here)

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.

4 participants