Skip to content

Conversation

@remarkablemark
Copy link
Contributor

@remarkablemark remarkablemark commented Mar 30, 2025

What does this PR do?

Fix environment variables in installation.md

See https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables#hfhubdisabletelemetry

Before submitting

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

Copy link
Contributor

@hlky hlky left a comment

Choose a reason for hiding this comment

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

Hi @remarkablemark.

HF_HUB_OFFLINE and other environment variables/constants use _is_true which support multiple truth values including True or YES, likewise we support multiple environment variables to disable telemetry (to note, the telemetry is very minimal, one of the main purposes is powering "Download" count on the Hub), project-specific environment variables like HF_HUB_DISABLE_TELEMETRY are common, makes sense to use that in documentation rather than DISABLE_TELEMETRY which doesn't appear to be any kind of standard like DO_NOT_TRACK, so thanks for making that change!

I will hand over to @stevhliu for comment on whether documentation adopt the common value 1 and final approval.

@HuggingFaceDocBuilderDev

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.

@remarkablemark
Copy link
Contributor Author

@hlky thanks for the comment! Happy to change the value to True or YES if that's the preferred convention.

Copy link
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

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

Thanks! Let's use 1 to align with the huggingface_hub docs 👍

@stevhliu stevhliu merged commit eb50def into huggingface:main Mar 31, 2025
1 check passed
@remarkablemark remarkablemark deleted the patch-1 branch March 31, 2025 16:36
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