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

[Docs] Add Authentication Note and Link to Guided Tour in Quick Demo Section #596

Open
yuka-with-data opened this issue Feb 10, 2025 · 0 comments

Comments

@yuka-with-data
Copy link

The current Quick demo section in the smolagents README does not mention that authentication may be necessary for certain use cases, especially when using HfApiModel. This can lead to confusion when users encounter errors or when trying to access gated models.

Suggested Change

Add a short note in the Quick demo section explaining that:

  • Users may need to authenticate to avoid rate limits or access gated models.
  • Link to Guided Tour for detailed instructions on how to set the token.

Why This is Important

  • Helps new users avoid common errors
  • Ensures smoother onboarding experience
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

No branches or pull requests

1 participant