You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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.
The text was updated successfully, but these errors were encountered:
dosubotbot
added
the
🤖:docs
Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder
label
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
Issue with current documentation:
In the
langchain_huggingface
package, theHuggingFaceEndpoint
class has a required field named model, which is used to specify the model name, such asmicrosoft/Phi-3-mini-4k-instruct
. However, the corresponding documentation does not include any details about this property.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:model
field is required.repo_id
field is marked as optional.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
andmodel
, and describing the purposes of each property.The text was updated successfully, but these errors were encountered: