Revise README with setup information for huggingface_lib on windows to avoid warning or save space (symlink) #2293
Conversation
Updated the README to include information for windows users. using huggingface_hub yield a warning. The this note documents ways to fix the problem or to hide the warning. fix for microsoft#2289
bmerkle
changed the title
Updated README to improve formatting and content clarity. added feedback from shaahji
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
README.md
Outdated
| > [!NOTE] | ||
| > For Windows users: to avoid HF_HUB_DISABLE_SYMLINKS_WARNING | ||
| > |
Check warning
Code scanning / lintrunner
EDITORCONFIG-CHECKER/editorconfig Warning
README.md
Outdated
| > For Windows users: to avoid HF_HUB_DISABLE_SYMLINKS_WARNING | ||
| > | ||
| > Olive depends on huggingface_hub library if you download models from there. On Windows you will get a warning like | ||
| > |
Check warning
Code scanning / lintrunner
EDITORCONFIG-CHECKER/editorconfig Warning
README.md
Outdated
| > Olive depends on huggingface_hub library if you download models from there. On Windows you will get a warning like | ||
| > | ||
| > ``` | ||
| > UserWarning: `huggingface_hub` cache-system uses symlinks by default to efficiently store duplicated files but your machine does not support them in C:\Users\name\.cache\huggingface\hub\model-name. |
Check warning
Code scanning / lintrunner
EDITORCONFIG-CHECKER/editorconfig Warning
README.md
Outdated
| > UserWarning: `huggingface_hub` cache-system uses symlinks by default to efficiently store duplicated files but your machine does not support them in C:\Users\name\.cache\huggingface\hub\model-name. | ||
| > Caching files will still work but in a degraded version that might require more space on your disk. This warning can be disabled by setting the `HF_HUB_DISABLE_SYMLINKS_WARNING` environment variable. For more details, see https://huggingface.co/docs/huggingface_hub/how-to-cache#limitations. | ||
| > ``` | ||
| > |
Check warning
Code scanning / lintrunner
EDITORCONFIG-CHECKER/editorconfig Warning
README.md
Outdated
| > ``` | ||
| > | ||
| > You can fix this warning using one of the 4 options below. Note that option 1, 2 and 3 saves diskspace, while option 4 only supresses the warning | ||
| > |
Check warning
Code scanning / lintrunner
EDITORCONFIG-CHECKER/editorconfig Warning
README.md
Outdated
| > 2. Run Python as administrator when using Olive with the huggingface_hub library. | ||
| > 3. Reconfigure where the cache is stored. This restriction is not limited to storing the cache in the default location only. | ||
| > 4. Keep using HF_HUB_DISABLE_SYMLINKS_WARNING=1 to suppress the warning and accept the extra disk usage. | ||
| > |
Check warning
Code scanning / lintrunner
EDITORCONFIG-CHECKER/editorconfig Warning
Head branch was pushed to by a user without write access
2 participants
Updated the README to include information for windows users. using huggingface_hub yield a warning.
The this note documents ways to fix the problem or to hide the warning.
fix for #2289
Describe your changes
updated docs and tested
Checklist before requesting a review
lintrunner -a(Optional) Issue link
#2289