Skip to content

[Docs] Fix environment variables in installation.md #11179

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

Jump to bottom
Merged
merged 1 commit into from
Mar 31, 2025
Merged

[Docs] Fix environment variables in installation.md #11179

merged 1 commit into from
Mar 31, 2025

Conversation

remarkablemark
Copy link
Contributor

@remarkablemark remarkablemark commented Mar 30, 2025 •
edited
Loading

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.

hlky
hlky approved these changes Mar 31, 2025
View reviewed changes
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
Copy link

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.

stevhliu
stevhliu approved these changes Mar 31, 2025
View reviewed changes
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
jonluca added a commit to weights-ai/diffusers that referenced this pull request Apr 3, 2025
@jonluca @a-r-r-o-w
@remarkablemark @hlky @kakukakujirori @DN6 @yiyixuxu @faaany @yao-matrix @jiqing-feng @elismasilva @bm-synth @sayakpaul @Lakshaysharma048 @chiral-carbon @BasileLewan @hanouticelina
sync head (#5)
8b29764 
* Raise warning and round down if Wan num_frames is not 4k + 1 (huggingface#11167)

* update

* raise warning and round to nearest multiple of scale factor

* [Docs] Fix environment variables in `installation.md` (huggingface#11179)

* Add `latents_mean` and `latents_std` to `SDXLLongPromptWeightingPipeline` (huggingface#11034)

* Bug fix in LTXImageToVideoPipeline.prepare_latents() when latents is already set (huggingface#10918)

* Bug fix in ltx

* Assume packed latents.

---------

Co-authored-by: Dhruv Nair <dhruv.nair@gmail.com>
Co-authored-by: YiYi Xu <yixu310@gmail.com>

* [tests] no hard-coded cuda  (huggingface#11186)

no cuda only

* [WIP] Add Wan Video2Video (huggingface#11053)

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* map BACKEND_RESET_MAX_MEMORY_ALLOCATED to reset_peak_memory_stats on XPU (huggingface#11191)

Signed-off-by: YAO Matrix <matrix.yao@intel.com>

* fix autocast (huggingface#11190)

Signed-off-by: jiqing-feng <jiqing.feng@intel.com>

* fix: for checking mandatory and optional pipeline components (huggingface#11189)

fix: optional componentes verification on load

* remove unnecessary call to `F.pad` (huggingface#10620)

* rewrite memory count without implicitly using dimensions by @ic-synth

* replace F.pad by built-in padding in Conv3D

* in-place sums to reduce memory allocations

* fixed trailing whitespace

* file reformatted

* in-place sums

* simpler in-place expressions

* removed in-place sum, may affect backward propagation logic

* removed in-place sum, may affect backward propagation logic

* removed in-place sum, may affect backward propagation logic

* reverted change

* allow models to run with a user-provided dtype map instead of a single dtype (huggingface#10301)

* allow models to run with a user-provided dtype map instead of a single dtype

* make style

* Add warning, change `_` to `default`

* make style

* add test

* handle shared tensors

* remove warning

---------

Co-authored-by: Sayak Paul <spsayakpaul@gmail.com>

* [tests] HunyuanDiTControlNetPipeline inference precision issue on XPU (huggingface#11197)

* add xpu part

* fix more cases

* remove some cases

* no canny

* format fix

* Revert `save_model` in ModelMixin save_pretrained and use safe_serialization=False in test (huggingface#11196)

* [docs] `torch_dtype` map (huggingface#11194)

* Fix enable_sequential_cpu_offload in CogView4Pipeline (huggingface#11195)

* Fix enable_sequential_cpu_offload in CogView4Pipeline

* make fix-copies

* SchedulerMixin from_pretrained and ConfigMixin Self type annotation (huggingface#11192)

* Update import_utils.py (huggingface#10329)

added onnxruntime-vitisai for custom build onnxruntime pkg

* Add CacheMixin to Wan and LTX Transformers (huggingface#11187)

* update

* update

* update

* feat: [Community Pipeline] - FaithDiff Stable Diffusion XL Pipeline (huggingface#11188)

* feat: [Community Pipeline] - FaithDiff Stable Diffusion XL Pipeline for Image SR.

* added pipeline

* [Model Card] standardize advanced diffusion training sdxl lora (huggingface#7615)

* model card gen code

* push modelcard creation

* remove optional from params

* add import

* add use_dora check

* correct lora var use in tags

* make style && make quality

---------

Co-authored-by: Aryan <aryan@huggingface.co>
Co-authored-by: Sayak Paul <spsayakpaul@gmail.com>

* Change KolorsPipeline LoRA Loader to StableDiffusion (huggingface#11198)

Change LoRA Loader to StableDiffusion

Replace the SDXL LoRA Loader Mixin inheritance with the StableDiffusion one

* Update Style Bot workflow (huggingface#11202)

update style bot workflow

---------

Signed-off-by: YAO Matrix <matrix.yao@intel.com>
Signed-off-by: jiqing-feng <jiqing.feng@intel.com>
Co-authored-by: Aryan <aryan@huggingface.co>
Co-authored-by: Mark <remarkablemark@users.noreply.github.com>
Co-authored-by: hlky <hlky@hlky.ac>
Co-authored-by: kakukakujirori <63725741+kakukakujirori@users.noreply.github.com>
Co-authored-by: Dhruv Nair <dhruv.nair@gmail.com>
Co-authored-by: YiYi Xu <yixu310@gmail.com>
Co-authored-by: Fanli Lin <fanli.lin@intel.com>
Co-authored-by: Yao Matrix <matrix.yao@intel.com>
Co-authored-by: jiqing-feng <jiqing.feng@intel.com>
Co-authored-by: Eliseu Silva <elismasilva@gmail.com>
Co-authored-by: Bruno Magalhaes <bruno.magalhaes@synthesia.io>
Co-authored-by: Sayak Paul <spsayakpaul@gmail.com>
Co-authored-by: lakshay sharma <31830611+Lakshaysharma048@users.noreply.github.com>
Co-authored-by: Abhipsha Das <ad6489@nyu.edu>
Co-authored-by: Basile Lewandowski <basile.lewan@gmail.com>
Co-authored-by: célina <hanouticelina@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stevhliu stevhliu stevhliu approved these changes

@hlky hlky hlky approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@remarkablemark @HuggingFaceDocBuilderDev @stevhliu @hlky