Add messages api compatibility docs #1478
Merged
Conversation
This file contains hidden or 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
philschmid
reviewed
Jan 25, 2024
| TGI can be deployed on various cloud providers for scalable and robust text generation. One such provider is Amazon SageMaker, which has recently added support for TGI. Here's how you can deploy TGI on Amazon SageMaker: | ||
|
|
||
| ## Amazon SageMaker | ||
|
|
There was a problem hiding this comment.
We should add a note with the min required version for the support of the messages API. I might confuse people
|
|
||
| _Messages API is compatible to OpenAI Chat Completion API_ | ||
|
|
||
| Text Generation Inference (TGI) now supports the Message API which is fully compatible with the OpenAI Chat Completion API. This means you can use OpenAI's client libraries to interact with TGI's Messages API. Below are some examples of how to utilize this compatibility. |
There was a problem hiding this comment.
Sugg:
Text Generation Inference (TGI) now supports the Message API, which is fully compatible with the OpenAI Chat Completion API. You can use OpenAI's client libraries or third-party libraries expecting OpenAI schema to interact with TGI's Messages API. Below are some examples of how to utilize this compatibility.
| hub = { | ||
| 'HF_MODEL_ID':'HuggingFaceH4/zephyr-7b-beta', | ||
| 'SM_NUM_GPUS': json.dumps(1), | ||
| 'MESSAGES_API_ENABLED': True |
kdamaszk
pushed a commit
to kdamaszk/tgi-gaudi
that referenced
this pull request
Apr 29, 2024
This PR adds a new page to the docs that describes the Messages API and how to use it. Additionally this page will contain cloud provider specific information for enabling and using this feature. This PR includes a SageMaker example/information.
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.
This PR adds a new page to the docs that describes the Messages API and how to use it.
Additionally this page will contain cloud provider specific information for enabling and using this feature. This PR includes a SageMaker example/information.