chore: Update HF docs to include more clarity around datasets and revisions.#345
chore: Update HF docs to include more clarity around datasets and revisions.#345nicholasmccrea wants to merge 2 commits intomainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
Updates the Hugging Face repository documentation to use non-realistic example names and to better explain downloading datasets and selecting a revision for downloads.
Changes:
- Replaced real-world model references with example names in Python and CLI snippets.
- Added a Python example for downloading datasets via
repo_type="dataset". - Added revision explanation notes for both
huggingface_hubandhfCLI download flows.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| The `revision` parameter defaults to `"main"` if omitted. The value can be: | ||
|
|
||
| - A **branch name**, e.g., `revision="main"` or `revision="dev"` | ||
| - A **full commit SHA**, e.g., `revision="a1b2c3d4e5f67890abcdef1234567890abcdef12"` | ||
| - A **version tag**, e.g., `revision="v1.0"` or `revision="1.2.3"` | ||
|
|
There was a problem hiding this comment.
In this Revision note, calling revision a "version tag" is ambiguous given the earlier section where a Hugging Face tag maps to a Cloudsmith package tag. Consider renaming this bullet to "tag name" or "git tag" to keep terminology consistent and avoid implying Cloudsmith package versions are semver strings.
|
|
||
| - A **branch name**, e.g., `--revision main` or `--revision dev` | ||
| - A **full commit SHA**, e.g., `--revision a1b2c3d4e5f67890abcdef1234567890abcdef12` | ||
| - A **version tag**, e.g., `--revision v1.0` or `--revision 1.2.3` |
There was a problem hiding this comment.
Same terminology issue here: describing --revision v1.0 / --revision 1.2.3 as a "version tag" can be confusing given the page's tag/version mapping. Prefer "tag name" / "git tag" to align with the earlier Tags section.
| - A **version tag**, e.g., `--revision v1.0` or `--revision 1.2.3` | |
| - A **tag name**, e.g., `--revision v1.0` or `--revision 1.2.3` |
1 participant
datasetsand how to download themrevision