Enhance tgi README for ArtifactHUB. #517
Conversation
Signed-off-by: Yugar-1 <xiaoyu.zhang@intel.com>
for more information, see https://pre-commit.ci
| helm install tgi tgi --set global.modelUseHostPath=${MODELDIR} --set LLM_MODEL_ID=${MODELNAME} --set global.HUGGINGFACEHUB_API_TOKEN=${HFTOKEN} | ||
| # To deploy on Gaudi enabled kubernetes cluster | ||
| # helm install tgi tgi --set global.modelUseHostPath=${MODELDIR} --set LLM_MODEL_ID=${MODELNAME} --set global.HUGGINGFACEHUB_API_TOKEN=${HFTOKEN} --values gaudi-values.yaml | ||
| helm repo add opea https://opea-project.github.io/GenAIInfra |
There was a problem hiding this comment.
As there are discussions about where to release the helm charts, I think it would be better to put only chart options and verification part in the README.
The deployment part might be different if users are getting the helm chart from various places.
Let's involve @poussa @eero-t to bring more experience. (For a better readme before v1.1 release)
There was a problem hiding this comment.
The less duplication, the better. There could e.g. be a link to project README instead:
https://github.com/opea-project/GenAIInfra/blob/main/helm-charts/README.md#deploy-with-helm-charts
| | horizontalPodAutoscaler.enabled | bool | false | Enable HPA autoscaling for the service deployment based on metrics it provides. See [HPA instructions](../../HPA.md) before enabling! | | ||
| | global.monitoring | bool | false | Enable usage metrics for the service. Required for HPA. See [monitoring instructions](../../monitoring.md) before enabling! | |
|
As we are still discussing where to host the OPEA helm charts, let's not merge PRs related to this area before we have reached a conclusion. The top candidates for Helm chart hosting are currently |
|
Close this PR as we decided to use ghcr.io |
Description
The summary of the proposed changes as long as the relevant motivation and context.
Enhance tgi README for ArtifactHUB.
Issues
List the issue or RFC link this PR is working on. If there is no such link, please mark it as
n/a.n/a
Type of change
List the type of change like below. Please delete options that are not relevant.
n/a
Dependencies
List the newly introduced 3rd party dependency if exists.
n/a
Tests
Describe the tests that you ran to verify your changes.
n/a