Promote chat_completion in inference guide #2366
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gary149
reviewed
Jul 2, 2024
gary149
reviewed
Jul 2, 2024
docs/source/en/guides/inference.md
Outdated
|
|
||
| In the example above, we initialized an [`InferenceClient`] with the default parameters. The only thing you need to know is the [task](#supported-tasks) you want to perform. By default, the client will connect to the Inference API and select a model to complete the task. In our example, we generated an image from a text prompt. The returned value is a `PIL.Image` object that can be saved to a file. For more details, check out the [`~InferenceClient.text_to_image`] documentation. | ||
|
|
||
| Let's now see an example using the chat-completion API. This task uses an LLM to generate a response from a list of messages: |
There was a problem hiding this comment.
Maybe specify what kind of models are compatible with the chat-completion API.
There was a problem hiding this comment.
chat-completion -> chat_completion?
There was a problem hiding this comment.
Good call, I have added a link to https://huggingface.co/models?other=conversational&sort=likes
gary149
approved these changes
Jul 2, 2024
There was a problem hiding this comment.
Nice! cc @merveenoyan maybe a chat completion example + short explanation on https://huggingface.co/tasks/text-generation could be nice too.
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
MoritzLaurer
pushed a commit
to MoritzLaurer/huggingface_hub
that referenced
this pull request
Jul 3, 2024
* Promote chat_completion in inference guide * fix KO docs * update example + list conversational models * feedback * fix KO? * fix fix KO * ko * fix fix fix
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
cc @gary149 who suggested it on slack. This PR adds a
chat_completionexample in theGetting startedsection of the guide.