khoj/documentation/docs/advanced/lmstudio.md

# LM Studio
:::info
This is only helpful for self-hosted users. If you're using [Khoj Cloud](https://app.khoj.dev), you're limited to our first-party models.
:::

:::info
Khoj natively supports local LLMs [available on HuggingFace in GGUF format](https://huggingface.co/models?library=gguf). Using an OpenAI API proxy with Khoj maybe useful for ease of setup, trying new models or using commercial LLMs via API.
:::

[LM Studio](https://lmstudio.ai/) is a desktop app to chat with open-source LLMs on your local machine. LM Studio provides a neat interface for folks comfortable with a GUI.

LM Studio can expose an [OpenAI API compatible server](https://lmstudio.ai/docs/local-server). This makes it possible to turn chat models from LM Studio into your personal AI agents with Khoj.

## Setup
1. Install [LM Studio](https://lmstudio.ai/) and download your preferred Chat Model
2. Go to the Server Tab on LM Studio, Select your preferred Chat Model and Click the green Start Server button
3. Create a new [OpenAI Processor Conversation Config](http://localhost:42110/server/admin/database/openaiprocessorconversationconfig/add) on your Khoj admin panel
   - Name: `proxy-name`
   - Api Key: `any string`
   - Api Base Url: `http://localhost:1234/v1/` (default for LMStudio)
4. Create a new [Chat Model](http://localhost:42110/server/admin/database/chatmodel/add) on your Khoj admin panel.
   - Name: `llama3.1` (replace with the name of your local model)
   - Model Type: `Openai`
   - Openai Config: `<the proxy config you created in step 3>`
   - Max prompt size: `20000` (replace with the max prompt size of your model)
   - Tokenizer: *Do not set for OpenAI, mistral, llama3 based models*
5. Go to [your config](http://localhost:42110/settings) and select the model you just created in the chat model dropdown.
Split setup of specific OpenAI API proxies into separate doc pages 2024-06-24 09:24:50 +00:00			`# LM Studio`
			`:::info`
			`This is only helpful for self-hosted users. If you're using [Khoj Cloud](https://app.khoj.dev), you're limited to our first-party models.`
			`:::`

			`:::info`
			`Khoj natively supports local LLMs [available on HuggingFace in GGUF format](https://huggingface.co/models?library=gguf). Using an OpenAI API proxy with Khoj maybe useful for ease of setup, trying new models or using commercial LLMs via API.`
			`:::`

			`[LM Studio](https://lmstudio.ai/) is a desktop app to chat with open-source LLMs on your local machine. LM Studio provides a neat interface for folks comfortable with a GUI.`

			`LM Studio can expose an [OpenAI API compatible server](https://lmstudio.ai/docs/local-server). This makes it possible to turn chat models from LM Studio into your personal AI agents with Khoj.`

			`## Setup`
			`1. Install [LM Studio](https://lmstudio.ai/) and download your preferred Chat Model`
			`2. Go to the Server Tab on LM Studio, Select your preferred Chat Model and Click the green Start Server button`
			`3. Create a new [OpenAI Processor Conversation Config](http://localhost:42110/server/admin/database/openaiprocessorconversationconfig/add) on your Khoj admin panel`
			- Name: `proxy-name`
			- Api Key: `any string`
			- Api Base Url: `http://localhost:1234/v1/` (default for LMStudio)
Rename Chat Model Options table to Chat Model as short & readable (#1003) - Previous was incorrectly plural but was defining only a single model - Rename chat model table field to name - Update documentation - Update references functions and variables to match new name 2024-12-12 19:24:16 +00:00			`4. Create a new [Chat Model](http://localhost:42110/server/admin/database/chatmodel/add) on your Khoj admin panel.`
Update docs to mention using Llama 3.1 and 20K max prompt size for it Update stale credits to better reflect bigger open source dependencies 2024-08-23 03:27:58 +00:00			- Name: `llama3.1` (replace with the name of your local model)
Split setup of specific OpenAI API proxies into separate doc pages 2024-06-24 09:24:50 +00:00			- Model Type: `Openai`
			- Openai Config: `<the proxy config you created in step 3>`
Update docs to mention using Llama 3.1 and 20K max prompt size for it Update stale credits to better reflect bigger open source dependencies 2024-08-23 03:27:58 +00:00			- Max prompt size: `20000` (replace with the max prompt size of your model)
Split setup of specific OpenAI API proxies into separate doc pages 2024-06-24 09:24:50 +00:00			`- Tokenizer: Do not set for OpenAI, mistral, llama3 based models`
Remove need to set server chat settings from use openai proxies docs This was previously required, but now it's only usefuly for more advanced settings, not typical for self-hosting users. With recent updates, the user's selected chat model is used for both Khoj's train of thought and response. This makes it easy to switch your preferred chat model directly from the user settings page and not have to update this in the admin panel as well. Reflect these code changse in the docs, by removing the unnecessary step for self-hosted users to create a server chat setting when using an OpenAI proxy service like Ollama, LiteLLM etc. 2024-11-06 01:03:17 +00:00			`5. Go to [your config](http://localhost:42110/settings) and select the model you just created in the chat model dropdown.`