From 847de09308572fd18d498acba268f9db46424c8f Mon Sep 17 00:00:00 2001 From: Krrish Dholakia Date: Tue, 31 Oct 2023 17:29:52 -0700 Subject: [PATCH] docs(simple_proxy.md): add model alias to docs --- docs/my-website/docs/simple_proxy.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/my-website/docs/simple_proxy.md b/docs/my-website/docs/simple_proxy.md index 3e1c016c074..fd6df782950 100644 --- a/docs/my-website/docs/simple_proxy.md +++ b/docs/my-website/docs/simple_proxy.md @@ -470,6 +470,23 @@ model_list: ```shell docker run -e PORT=8000 -p 8000:8000 -v $(pwd)/config.yaml:/app/config.yaml ghcr.io/berriai/litellm:latest ``` +## Model Alias + +Set a model alias for your deployments. + +In the `config.yaml` the model_name parameter is the user-facing name to use for your deployment. + +E.g.: If we want to save a Huggingface TGI Mistral-7b deployment, as 'mistral-7b' for our users, we might save it as: + +```yaml +model_list: + - model_name: mistral-7b # ALIAS + litellm_params: + model: huggingface/mistralai/Mistral-7B-Instruct-v0.1 # ACTUAL NAME + api_key: your_huggingface_api_key # [OPTIONAL] if deployed on huggingface inference endpoints + api_base: your_api_base # url where model is deployed +``` + ## Caching Add Redis Caching to your server via environment variables