Skip to content

document Hugging Face authentication for local inference - #283

Open
Nianze Wu (wunianze666-netizen) wants to merge 2 commits into
Lightricks:mainfrom
wunianze666-netizen:docs/add-hf-auth-note
Open

document Hugging Face authentication for local inference#283
Nianze Wu (wunianze666-netizen) wants to merge 2 commits into
Lightricks:mainfrom
wunianze666-netizen:docs/add-hf-auth-note

Conversation

@wunianze666-netizen

Copy link
Copy Markdown

Summary

This PR adds a short Hugging Face authentication note to the local setup section.

Motivation

While reviewing the local inference instructions, I noticed that inference.py downloads weights from the Hugging Face Hub via hf_hub_download(), but the README currently does not mention that users may need to accept the model terms and authenticate locally first.

This can lead to a 401 Unauthorized error on the first local inference run, as reported in #208.

Changes

  • add a small Model access note under local installation
  • point users to the model page to accept the terms if needed
  • document a minimal hf auth login flow before running local inference

Testing

  • Not run: README-only change.

Notes

This is intended to be a small documentation fix for first-run setup friction.

@wunianze666-netizen

Copy link
Copy Markdown
Author

Cleaned up the branch so the PR now contains only the 11-line model-access note. The earlier commit had accidentally changed README emoji and punctuation encoding; those unrelated changes are fully removed. I also dropped the unnecessary package-upgrade command, verified the model page returns HTTP 200, and reran git diff --check.

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.

1 participant