docs: update path from category -> guides
This commit is contained in:
parent
07ef5b8144
commit
fc8eb28195
@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Engineering Specs
|
title: Engineering Specs
|
||||||
slug: /docs/engineering
|
slug: /developer/engineering
|
||||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||||
keywords:
|
keywords:
|
||||||
[
|
[
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Product Specs
|
title: Product Specs
|
||||||
slug: /docs/product
|
slug: /developer/product
|
||||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||||
keywords:
|
keywords:
|
||||||
[
|
[
|
||||||
|
|||||||
22
docs/docs/guides/changelogs/README.mdx
Normal file
22
docs/docs/guides/changelogs/README.mdx
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
---
|
||||||
|
title: Changelogs
|
||||||
|
slug: /guides/changelogs/
|
||||||
|
sidebar_position: 12
|
||||||
|
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||||
|
keywords:
|
||||||
|
[
|
||||||
|
Jan AI,
|
||||||
|
Jan,
|
||||||
|
ChatGPT alternative,
|
||||||
|
local AI,
|
||||||
|
private AI,
|
||||||
|
conversational AI,
|
||||||
|
no-subscription fee,
|
||||||
|
large language model,
|
||||||
|
build extension,
|
||||||
|
]
|
||||||
|
---
|
||||||
|
|
||||||
|
import DocCardList from "@theme/DocCardList";
|
||||||
|
|
||||||
|
<DocCardList />
|
||||||
@ -1,8 +0,0 @@
|
|||||||
{
|
|
||||||
"label": "Changelogs",
|
|
||||||
"position": 5,
|
|
||||||
"link": {
|
|
||||||
"type": "generated-index",
|
|
||||||
"description": "Changelog for Jan"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
22
docs/docs/guides/common-error/README.mdx
Normal file
22
docs/docs/guides/common-error/README.mdx
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
---
|
||||||
|
title: Common Error
|
||||||
|
slug: /guides/common-error/
|
||||||
|
sidebar_position: 8
|
||||||
|
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||||
|
keywords:
|
||||||
|
[
|
||||||
|
Jan AI,
|
||||||
|
Jan,
|
||||||
|
ChatGPT alternative,
|
||||||
|
local AI,
|
||||||
|
private AI,
|
||||||
|
conversational AI,
|
||||||
|
no-subscription fee,
|
||||||
|
large language model,
|
||||||
|
build extension,
|
||||||
|
]
|
||||||
|
---
|
||||||
|
|
||||||
|
import DocCardList from "@theme/DocCardList";
|
||||||
|
|
||||||
|
<DocCardList />
|
||||||
@ -1,8 +0,0 @@
|
|||||||
{
|
|
||||||
"label": "Common Error",
|
|
||||||
"position": 8,
|
|
||||||
"link": {
|
|
||||||
"type": "generated-index",
|
|
||||||
"description": "List of common errors for Jan users"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
22
docs/docs/guides/error-codes/README.mdx
Normal file
22
docs/docs/guides/error-codes/README.mdx
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
---
|
||||||
|
title: Error Codes
|
||||||
|
slug: /guides/error-codes/
|
||||||
|
sidebar_position: 7
|
||||||
|
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||||
|
keywords:
|
||||||
|
[
|
||||||
|
Jan AI,
|
||||||
|
Jan,
|
||||||
|
ChatGPT alternative,
|
||||||
|
local AI,
|
||||||
|
private AI,
|
||||||
|
conversational AI,
|
||||||
|
no-subscription fee,
|
||||||
|
large language model,
|
||||||
|
build extension,
|
||||||
|
]
|
||||||
|
---
|
||||||
|
|
||||||
|
import DocCardList from "@theme/DocCardList";
|
||||||
|
|
||||||
|
<DocCardList />
|
||||||
@ -1,8 +0,0 @@
|
|||||||
{
|
|
||||||
"label": "Error Codes",
|
|
||||||
"position": 7,
|
|
||||||
"link": {
|
|
||||||
"type": "generated-index",
|
|
||||||
"description": "List of Error Codes for Jan users"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
22
docs/docs/guides/extensions/README.mdx
Normal file
22
docs/docs/guides/extensions/README.mdx
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
---
|
||||||
|
title: Extensions
|
||||||
|
slug: /guides/extensions/
|
||||||
|
sidebar_position: 5
|
||||||
|
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||||
|
keywords:
|
||||||
|
[
|
||||||
|
Jan AI,
|
||||||
|
Jan,
|
||||||
|
ChatGPT alternative,
|
||||||
|
local AI,
|
||||||
|
private AI,
|
||||||
|
conversational AI,
|
||||||
|
no-subscription fee,
|
||||||
|
large language model,
|
||||||
|
build extension,
|
||||||
|
]
|
||||||
|
---
|
||||||
|
|
||||||
|
import DocCardList from "@theme/DocCardList";
|
||||||
|
|
||||||
|
<DocCardList />
|
||||||
@ -1,8 +0,0 @@
|
|||||||
{
|
|
||||||
"label": "Extensions",
|
|
||||||
"position": 5,
|
|
||||||
"link": {
|
|
||||||
"type": "generated-index",
|
|
||||||
"description": "More info regarding Extensions for Jan"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
22
docs/docs/guides/integration/README.mdx
Normal file
22
docs/docs/guides/integration/README.mdx
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
---
|
||||||
|
title: Integrations
|
||||||
|
slug: /guides/integrations/
|
||||||
|
sidebar_position: 6
|
||||||
|
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||||
|
keywords:
|
||||||
|
[
|
||||||
|
Jan AI,
|
||||||
|
Jan,
|
||||||
|
ChatGPT alternative,
|
||||||
|
local AI,
|
||||||
|
private AI,
|
||||||
|
conversational AI,
|
||||||
|
no-subscription fee,
|
||||||
|
large language model,
|
||||||
|
build extension,
|
||||||
|
]
|
||||||
|
---
|
||||||
|
|
||||||
|
import DocCardList from "@theme/DocCardList";
|
||||||
|
|
||||||
|
<DocCardList />
|
||||||
@ -1,8 +0,0 @@
|
|||||||
{
|
|
||||||
"label": "Integrations",
|
|
||||||
"position": 6,
|
|
||||||
"link": {
|
|
||||||
"type": "generated-index",
|
|
||||||
"description": "More info regarding Jan.ai integrations"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -70,27 +70,9 @@ The [Azure OpenAI Service](https://learn.microsoft.com/en-us/azure/ai-services/o
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Regarding `model.json`
|
:::note
|
||||||
|
For more details regarding the `model.json` settings and parameters fields, please see [here](../models/integrate-remote.mdx#modeljson).
|
||||||
- In `settings`, two crucial values are:
|
:::
|
||||||
- `ctx_len`: Defined based on the model's context size.
|
|
||||||
- `prompt_template`: Defined based on the model's trained template (e.g., ChatML, Alpaca).
|
|
||||||
- To set up the `prompt_template`:
|
|
||||||
1. Visit [Hugging Face](https://huggingface.co/), an open-source machine learning platform.
|
|
||||||
2. Find the current model that you're using (e.g., [Gemma 7b it](https://huggingface.co/google/gemma-7b-it)).
|
|
||||||
3. Review the text and identify the template.
|
|
||||||
- In `parameters`, consider the following options. The fields in `parameters` are typically general and can be the same across models. An example is provided below:
|
|
||||||
|
|
||||||
```json
|
|
||||||
"parameters":{
|
|
||||||
"temperature": 0.7,
|
|
||||||
"top_p": 0.95,
|
|
||||||
"stream": true,
|
|
||||||
"max_tokens": 4096,
|
|
||||||
"frequency_penalty": 0,
|
|
||||||
"presence_penalty": 0
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Step 3: Start the Model
|
### Step 3: Start the Model
|
||||||
|
|
||||||
|
|||||||
@ -80,27 +80,9 @@ Replace `(port)` with your chosen port number. The default is 1234.
|
|||||||
"engine": "openai"
|
"engine": "openai"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
### Regarding `model.json`
|
:::note
|
||||||
|
For more details regarding the `model.json` settings and parameters fields, please see [here](../models/integrate-remote.mdx#modeljson).
|
||||||
- In `settings`, two crucial values are:
|
:::
|
||||||
- `ctx_len`: Defined based on the model's context size.
|
|
||||||
- `prompt_template`: Defined based on the model's trained template (e.g., ChatML, Alpaca).
|
|
||||||
- To set up the `prompt_template`:
|
|
||||||
1. Visit [Hugging Face](https://huggingface.co/), an open-source machine learning platform.
|
|
||||||
2. Find the current model that you're using (e.g., [Gemma 7b it](https://huggingface.co/google/gemma-7b-it)).
|
|
||||||
3. Review the text and identify the template.
|
|
||||||
- In `parameters`, consider the following options. The fields in `parameters` are typically general and can be the same across models. An example is provided below:
|
|
||||||
|
|
||||||
```json
|
|
||||||
"parameters":{
|
|
||||||
"temperature": 0.7,
|
|
||||||
"top_p": 0.95,
|
|
||||||
"stream": true,
|
|
||||||
"max_tokens": 4096,
|
|
||||||
"frequency_penalty": 0,
|
|
||||||
"presence_penalty": 0
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### Step 3: Starting the Model
|
### Step 3: Starting the Model
|
||||||
|
|||||||
@ -73,33 +73,11 @@ This tutorial demonstrates integrating Mistral AI with Jan using the API.
|
|||||||
"engine": "openai"
|
"engine": "openai"
|
||||||
}
|
}
|
||||||
|
|
||||||
```
|
|
||||||
### Regarding `model.json`
|
|
||||||
|
|
||||||
- In `settings`, two crucial values are:
|
|
||||||
- `ctx_len`: Defined based on the model's context size.
|
|
||||||
- `prompt_template`: Defined based on the model's trained template (e.g., ChatML, Alpaca).
|
|
||||||
- To set up the `prompt_template`:
|
|
||||||
1. Visit [Hugging Face](https://huggingface.co/), an open-source machine learning platform.
|
|
||||||
2. Find the current model that you're using (e.g., [Gemma 7b it](https://huggingface.co/google/gemma-7b-it)).
|
|
||||||
3. Review the text and identify the template.
|
|
||||||
- In `parameters`, consider the following options. The fields in `parameters` are typically general and can be the same across models. An example is provided below:
|
|
||||||
|
|
||||||
```json
|
|
||||||
"parameters":{
|
|
||||||
"temperature": 0.7,
|
|
||||||
"top_p": 0.95,
|
|
||||||
"stream": true,
|
|
||||||
"max_tokens": 4096,
|
|
||||||
"frequency_penalty": 0,
|
|
||||||
"presence_penalty": 0
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
:::note
|
:::note
|
||||||
|
- For more details regarding the `model.json` settings and parameters fields, please see [here](../models/integrate-remote.mdx#modeljson).
|
||||||
Mistral AI offers various endpoints. Refer to their [endpoint documentation](https://docs.mistral.ai/platform/endpoints/) to select the one that fits your requirements. Here, we use the `mistral-tiny` model as an example.
|
- Mistral AI offers various endpoints. Refer to their [endpoint documentation](https://docs.mistral.ai/platform/endpoints/) to select the one that fits your requirements. Here, we use the `mistral-tiny` model as an example.
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
### Step 3: Start the Model
|
### Step 3: Start the Model
|
||||||
|
|||||||
@ -79,27 +79,9 @@ ollama run <model-name>
|
|||||||
"engine": "openai"
|
"engine": "openai"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
### Regarding `model.json`
|
:::note
|
||||||
|
For more details regarding the `model.json` settings and parameters fields, please see [here](../models/integrate-remote.mdx#modeljson).
|
||||||
- In `settings`, two crucial values are:
|
:::
|
||||||
- `ctx_len`: Defined based on the model's context size.
|
|
||||||
- `prompt_template`: Defined based on the model's trained template (e.g., ChatML, Alpaca).
|
|
||||||
- To set up the `prompt_template`:
|
|
||||||
1. Visit [Hugging Face](https://huggingface.co/), an open-source machine learning platform.
|
|
||||||
2. Find the current model that you're using (e.g., [Gemma 7b it](https://huggingface.co/google/gemma-7b-it)).
|
|
||||||
3. Review the text and identify the template.
|
|
||||||
- In `parameters`, consider the following options. The fields in `parameters` are typically general and can be the same across models. An example is provided below:
|
|
||||||
|
|
||||||
```json
|
|
||||||
"parameters":{
|
|
||||||
"temperature": 0.7,
|
|
||||||
"top_p": 0.95,
|
|
||||||
"stream": true,
|
|
||||||
"max_tokens": 4096,
|
|
||||||
"frequency_penalty": 0,
|
|
||||||
"presence_penalty": 0
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Step 3: Start the Model
|
### Step 3: Start the Model
|
||||||
1. Restart Jan and navigate to the **Hub**.
|
1. Restart Jan and navigate to the **Hub**.
|
||||||
|
|||||||
@ -49,27 +49,9 @@ To connect Jan with OpenRouter for accessing remote Large Language Models (LLMs)
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Regarding `model.json`
|
:::note
|
||||||
|
For more details regarding the `model.json` settings and parameters fields, please see [here](../models/integrate-remote.mdx#modeljson).
|
||||||
- In `settings`, two crucial values are:
|
:::
|
||||||
- `ctx_len`: Defined based on the model's context size.
|
|
||||||
- `prompt_template`: Defined based on the model's trained template (e.g., ChatML, Alpaca).
|
|
||||||
- To set up the `prompt_template`:
|
|
||||||
1. Visit [Hugging Face](https://huggingface.co/), an open-source machine learning platform.
|
|
||||||
2. Find the current model that you're using (e.g., [Gemma 7b it](https://huggingface.co/google/gemma-7b-it)).
|
|
||||||
3. Review the text and identify the template.
|
|
||||||
- In `parameters`, consider the following options. The fields in `parameters` are typically general and can be the same across models. An example is provided below:
|
|
||||||
|
|
||||||
```json
|
|
||||||
"parameters":{
|
|
||||||
"temperature": 0.7,
|
|
||||||
"top_p": 0.95,
|
|
||||||
"stream": true,
|
|
||||||
"max_tokens": 4096,
|
|
||||||
"frequency_penalty": 0,
|
|
||||||
"presence_penalty": 0
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Step 3 : Start the Model
|
### Step 3 : Start the Model
|
||||||
1. Restart Jan and go to the **Hub**.
|
1. Restart Jan and go to the **Hub**.
|
||||||
|
|||||||
22
docs/docs/guides/models/README.mdx
Normal file
22
docs/docs/guides/models/README.mdx
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
---
|
||||||
|
title: Models Setup
|
||||||
|
slug: /guides/models-setup/
|
||||||
|
sidebar_position: 5
|
||||||
|
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||||
|
keywords:
|
||||||
|
[
|
||||||
|
Jan AI,
|
||||||
|
Jan,
|
||||||
|
ChatGPT alternative,
|
||||||
|
local AI,
|
||||||
|
private AI,
|
||||||
|
conversational AI,
|
||||||
|
no-subscription fee,
|
||||||
|
large language model,
|
||||||
|
build extension,
|
||||||
|
]
|
||||||
|
---
|
||||||
|
|
||||||
|
import DocCardList from "@theme/DocCardList";
|
||||||
|
|
||||||
|
<DocCardList />
|
||||||
@ -1,8 +0,0 @@
|
|||||||
{
|
|
||||||
"label": "Advanced Models Setup",
|
|
||||||
"position": 5,
|
|
||||||
"link": {
|
|
||||||
"type": "generated-index",
|
|
||||||
"description": "More info regarding AI models for Jan"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Loading…
x
Reference in New Issue
Block a user