Skip to content
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.

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

Readme.md - Instruct how to get HF_TOKEN #1380

Merged
merged 2 commits into from
May 2, 2024

Conversation

natanloterio
Copy link
Contributor

This PR aims to improve the instructions on the README.md about how to use the Hugging Face access token
Although having this setup already is common knowledge to the experienced ML engineer, the new engineer might still need to be told how to do that.

After going through this situation myself ( see [#1363 ] ), I'm making this humble contribution to the project
adding instructions on the README.md on how to get an Hugging Face access token.

Let me know what do you think.

Cheers.

@rasbt
Copy link
Collaborator

rasbt commented May 2, 2024

Thanks a lot for the PR. We recently trimmed the Readme to keep it more minimal, but I agree that there should be some mention of the access token, which is required for some models. We do have a tutorial section on that in the download documents. I think the header was not very clear though so it was not easy to find.

I hope you don't mind, but I modified your PR a bit to link to the relevant documentation section instead.

@rasbt rasbt changed the title Readme.mnd - Instruct how to get HF_TOKEN Readme.md - Instruct how to get HF_TOKEN May 2, 2024
@natanloterio
Copy link
Contributor Author

Looks good 👍

@rasbt rasbt merged commit 2fa4d82 into Lightning-AI:main May 2, 2024
9 checks passed
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.

None yet

2 participants