Document the HF_DATASETS_CACHE environment variable in the datasets cache documentation #7532
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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. |
|
Your clarification in your comment at #7480 (comment) sounds great, would you like to update this PR to include it ? |
lhoestq
approved these changes
May 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request updates the Datasets documentation to include the
HF_DATASETS_CACHEenvironment variable. While the current documentation only mentionsHF_HOMEfor overriding the default cache directory,HF_DATASETS_CACHEis also a supported and useful option for specifying a custom cache location for datasets stored in Arrow format.This addition is based on the discussion in (#7457), where users noted the absence of this variable in the documentation despite its functionality. The update adds a new section to
cache.mdxthat explains how to useHF_DATASETS_CACHEwith an example.This change aims to improve clarity and help users better manage their cache directories when working in shared environments or with limited local storage.
Closes #7457.