Skip to content

Commit

Permalink
Merge pull request #27 from justinh-rahb/main
Browse files Browse the repository at this point in the history
Add Model Filter Tutorial
  • Loading branch information
tjbck authored Mar 23, 2024
2 parents cc9ee5b + b598514 commit d8c3c67
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 6
sidebar_position: 5
title: "📋 FAQ"
---

Expand Down
2 changes: 1 addition & 1 deletion docs/research.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 7
sidebar_position: 8
title: "🧑‍🔬 Open WebUI for Research"
---

Expand Down
5 changes: 5 additions & 0 deletions docs/tutorial/images.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_position: 3
title: "Image Generation"
---

# Image Generation

Open WebUI now supports image generation through two backends: **AUTOMATIC1111** and **OpenAI DALL·E**. This guide will help you set up and use both options.
Expand Down
5 changes: 5 additions & 0 deletions docs/tutorial/litellm.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_position: 4
title: "LiteLLM Configuration"
---

# LiteLLM Configuration

[LiteLLM](https://litellm.vercel.app/docs/proxy/configs#quick-start) supports a variety of APIs, both OpenAI-compatible and others. To integrate a new API model, follow these instructions:
Expand Down
27 changes: 27 additions & 0 deletions docs/tutorial/whitelist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
sidebar_position: 5
title: "Model Whitelisting"
---

# Model Whitelisting

Open WebUI allows you to filter specific models for use in your instance. This feature is especially useful for administrators who want to control which models are available to users. Filtering can be done through the WebUI or by adding environment variables to the backend.

## Filtering via WebUI

![Model Filter Configuration](/img/tutorial_model_filter.png)

1. Go to **Admin Panel > Admin Settings**.
2. In the **Manage Models** section, you can enable or disable the feature, and add or remove models from the whitelist.
3. Click **Save** to apply your changes.

## Filtering via Environment Variables

You can also whitelist models by adding environment variables to the backend. This method is useful for automated deployments and can be done by adding the following environment variables to your `docker run` command:

```bash
-e MODEL_FILTER_ENABLED=True \
-e MODEL_FILTER_LIST="llama2:13b;mistral:latest;gpt-3.5-turbo" \
```

In this example, the `MODEL_FILTER_ENABLED` variable is set to `True` to enable the feature, and the `MODEL_FILTER_LIST` variable lists the models to be whitelisted. The format for the `MODEL_FILTER_LIST` variable is `model_name:version;model_name:version;...`.
Binary file added static/img/tutorial_model_filter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d8c3c67

Please sign in to comment.