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

DOC: Missing Information About the model Field in HuggingFaceEndpoint #29087

Open
2 tasks done
KnightChaser opened this issue Jan 8, 2025 · 0 comments
Open
2 tasks done
Labels
🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder

Comments

@KnightChaser
Copy link

KnightChaser commented Jan 8, 2025

URL

https://python.langchain.com/api_reference/huggingface/llms/langchain_huggingface.llms.huggingface_endpoint.HuggingFaceEndpoint.html#langchain_huggingface.llms.huggingface_endpoint.HuggingFaceEndpoint.model

Checklist

  • I added a very descriptive title to this issue.
  • I included a link to the documentation page I am referring to (if applicable).

Issue with current documentation:

In the langchain_huggingface package, the HuggingFaceEndpoint class has a required field named model, which is used to specify the model name, such as microsoft/Phi-3-mini-4k-instruct. However, the corresponding documentation does not include any details about this property.
image
image

This omission creates confusion, particularly because the repo_id field also accepts repository ID strings (e.g., microsoft/Phi-3-mini-4k-instruct). The key differences between these fields are as follows:

  • The model field is required.
  • The repo_id field is marked as optional.
  • The endpoint_url field requires the model's URL. (Not a part of current issue)

The lack of clear documentation for the model field, combined with its similarity to repo_id, makes it difficult for developers to understand which field to use.

Idea or request for content:

Writing the differences between the field repo_id and model, and describing the purposes of each property.

@dosubot dosubot bot added the 🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder label Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder
Projects
None yet
Development

No branches or pull requests

1 participant