Skip to content

[DO NOT MERGE] copy of 2293 #2310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jambayk wants to merge 4 commits into from
Closed

[DO NOT MERGE] copy of 2293 #2310

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
aded88b
Revise README with installation and optimization details
bmerkle Dec 20, 2025
a8b9686
Merge branch 'microsoft:main' into patch-2
bmerkle Jan 6, 2026
a7e45a4
Update README with feedback from PR #2293
bmerkle Jan 6, 2026
86a3e60
removed trailing whitespaces
bmerkle Jan 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,27 @@
> [!NOTE]
> Olive has optional dependencies that can be installed to enable additional features. Please refer to [Olive package config](./olive/olive_config.json) for the list of extras and their dependencies.

> [!NOTE]
> 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
>
> ```
> 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.
> ```
>
> 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 on line 58 in README.md

View workflow job for this annotation

GitHub Actions / Optional Lint 

[misspell] reported by reviewdog 🐶
"supresses" is a misspelling of "suppresses"

Raw Output:
./README.md:58:126: "supresses" is a misspelling of "suppresses"

Check warning on line 58 in README.md

View workflow job for this annotation

GitHub Actions / Optional Lint 

[misspell] reported by reviewdog 🐶
"supresses" is a misspelling of "suppresses"

Raw Output:
./README.md:58:126: "supresses" is a misspelling of "suppresses"
>
> 1. Enable Developer Mode on Windows (one-time setup) documented in the [Microsoft Developer Tools Docs](https://learn.microsoft.com/en-us/windows/advanced-settings/developer-mode).
> 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.
>
> Regarding the options, you should decide what is possible in your environment (e.g. company policy) and what fits best for you.
>
> The limitation of the huggingface_hub library is also documentd in the [Hub Client Library Docs](https://huggingface.co/docs/huggingface_hub/guides/manage-cache#limitations).

#### 2. Automatic Optimizer

In this quickstart you'll be optimizing [Qwen/Qwen2.5-0.5B-Instruct](https://huggingface.co/Qwen/Qwen2.5-0.5B-Instruct), which has many model files in the Hugging Face repo for different precisions that are not required by Olive.
Expand Down Expand Up @@ -108,3 +129,5 @@

[![Build Status](https://dev.azure.com/aiinfra/PublicPackages/_apis/build/status%2FOlive%20CI?label=Olive-CI)](https://dev.azure.com/aiinfra/PublicPackages/_build/latest?definitionId=1240)
[![Build Status](https://dev.azure.com/aiinfra/PublicPackages/_apis/build/status%2FOlive-ORT-Nightly?label=Olive-ORT-Nightly)](https://dev.azure.com/aiinfra/PublicPackages/_build/latest?definitionId=1279)


Loading