-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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 Google Cloud TGI integration via dedicated DLCs #2612
base: main
Are you sure you want to change the base?
Conversation
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. |
My 2 cents: In Reference > API Reference > HTTP API Reference > OpenAI Messages API > Cloud Provider, I would just point to https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/call-vertex-using-openai-library#supported-model-garden-models What you wrote fits a generic introduction about using TGI on GCP. I think it's valuable to add it to the TGI doc but this is not the right place. It could be in Tutorials or Getting Started with simple pointers to the existing doc in https://huggingface.co/docs/sagemaker/en/index for AWS and https://huggingface.co/docs/google-cloud/en/index for Google Cloud. |
Agree @pagezyhf, also the AWS SageMaker section there is also covering deployment + inference, which may be out of the scope of the section, right?
Yes that's right, that's why I also think that we should maybe have a dedicated entry for those with brief introduction plus pointers to the actual documentation pages we host separately Thanks for the replies @pagezyhf 🤗 WDYT about those @nbroad1881? |
Looks great to me! Thanks for doing this so quickly. Sorry I responded so slowly. |
|
||
To enable the Messages API in Amazon SageMaker you need to set the environment variable `MESSAGES_API_ENABLED=true`. | ||
|
||
This will modify the `/invocations` route to accept Messages dictonaries consisting out of role and content. See the example below on how to deploy Llama with the new Messages API. | ||
This will modify the `/invocations` route to accept Messages dictionaries consisting out of role and content. See the example below on how to deploy Llama with the new Messages API. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would say:
This will modify the
/invocations
route to accept Messages dictionaries. See the example below on how to deploy Llama with the new Messages API.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is subject to change, check main branch! now there will be no need for MESSAGES API ENABLED configuration parameter to use chat template or not
Agree, mentioned above too; I believe that something like "Using TGI on AWS" and "Using TGI on Google Cloud" may work better (?), happy to work on that for both AWS and Google Cloud if we decide to go that path. |
What does this PR do?
This PR adds Google Cloud within the TGI Documentation https://huggingface.co/docs/text-generation-inference/main/en/reference/api_reference#cloud-providers side-by-side with the Amazon SageMaker integration.
Warning
Before merging I wanted to first clarify whether it would make sense to have a separate section within the TGI documentation for the Cloud Providers; as not sure that the Google Cloud integration fits within the HTTP API Reference page? Maybe you can help clarify a bit better @nbroad1881
Before submitting
Pull Request section?
to it if that's the case.
documentation guidelines, and
here are tips on formatting docstrings.
Who can review?
@nbroad1881 @pagezyhf @philschmid