From fc8eb281952285db24ba911f59c302be2d3a64e1 Mon Sep 17 00:00:00 2001 From: Arista Indrajaya Date: Mon, 4 Mar 2024 16:40:31 +0700 Subject: [PATCH] docs: update path from category -> guides --- .../05-framework/03-engineering/README.mdx | 2 +- .../05-framework/03-product/README.mdx | 2 +- docs/docs/guides/changelogs/README.mdx | 22 ++++++++++++++++ docs/docs/guides/changelogs/_category_.json | 8 ------ docs/docs/guides/common-error/README.mdx | 22 ++++++++++++++++ docs/docs/guides/common-error/_category_.json | 8 ------ docs/docs/guides/error-codes/README.mdx | 22 ++++++++++++++++ docs/docs/guides/error-codes/_category_.json | 8 ------ docs/docs/guides/extensions/README.mdx | 22 ++++++++++++++++ docs/docs/guides/extensions/_category_.json | 8 ------ docs/docs/guides/integration/README.mdx | 22 ++++++++++++++++ docs/docs/guides/integration/_category_.json | 8 ------ docs/docs/guides/integration/azure.mdx | 24 +++-------------- docs/docs/guides/integration/lmstudio.mdx | 24 +++-------------- docs/docs/guides/integration/mistral.mdx | 26 ++----------------- docs/docs/guides/integration/ollama.mdx | 24 +++-------------- docs/docs/guides/integration/openrouter.mdx | 24 +++-------------- docs/docs/guides/models/README.mdx | 22 ++++++++++++++++ docs/docs/guides/models/_category_.json | 8 ------ 19 files changed, 148 insertions(+), 158 deletions(-) create mode 100644 docs/docs/guides/changelogs/README.mdx delete mode 100644 docs/docs/guides/changelogs/_category_.json create mode 100644 docs/docs/guides/common-error/README.mdx delete mode 100644 docs/docs/guides/common-error/_category_.json create mode 100644 docs/docs/guides/error-codes/README.mdx delete mode 100644 docs/docs/guides/error-codes/_category_.json create mode 100644 docs/docs/guides/extensions/README.mdx delete mode 100644 docs/docs/guides/extensions/_category_.json create mode 100644 docs/docs/guides/integration/README.mdx delete mode 100644 docs/docs/guides/integration/_category_.json create mode 100644 docs/docs/guides/models/README.mdx delete mode 100644 docs/docs/guides/models/_category_.json diff --git a/docs/docs/developer/05-framework/03-engineering/README.mdx b/docs/docs/developer/05-framework/03-engineering/README.mdx index 2fd9a5cc1..c3337ab2e 100644 --- a/docs/docs/developer/05-framework/03-engineering/README.mdx +++ b/docs/docs/developer/05-framework/03-engineering/README.mdx @@ -1,6 +1,6 @@ --- 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. keywords: [ diff --git a/docs/docs/developer/05-framework/03-product/README.mdx b/docs/docs/developer/05-framework/03-product/README.mdx index cce274f22..ca3a13b3a 100644 --- a/docs/docs/developer/05-framework/03-product/README.mdx +++ b/docs/docs/developer/05-framework/03-product/README.mdx @@ -1,6 +1,6 @@ --- 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. keywords: [ diff --git a/docs/docs/guides/changelogs/README.mdx b/docs/docs/guides/changelogs/README.mdx new file mode 100644 index 000000000..82e8662ab --- /dev/null +++ b/docs/docs/guides/changelogs/README.mdx @@ -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"; + + diff --git a/docs/docs/guides/changelogs/_category_.json b/docs/docs/guides/changelogs/_category_.json deleted file mode 100644 index 7b86610f6..000000000 --- a/docs/docs/guides/changelogs/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Changelogs", - "position": 5, - "link": { - "type": "generated-index", - "description": "Changelog for Jan" - } -} \ No newline at end of file diff --git a/docs/docs/guides/common-error/README.mdx b/docs/docs/guides/common-error/README.mdx new file mode 100644 index 000000000..f819eb72a --- /dev/null +++ b/docs/docs/guides/common-error/README.mdx @@ -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"; + + diff --git a/docs/docs/guides/common-error/_category_.json b/docs/docs/guides/common-error/_category_.json deleted file mode 100644 index efef6b79c..000000000 --- a/docs/docs/guides/common-error/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Common Error", - "position": 8, - "link": { - "type": "generated-index", - "description": "List of common errors for Jan users" - } -} \ No newline at end of file diff --git a/docs/docs/guides/error-codes/README.mdx b/docs/docs/guides/error-codes/README.mdx new file mode 100644 index 000000000..39fb37ac9 --- /dev/null +++ b/docs/docs/guides/error-codes/README.mdx @@ -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"; + + diff --git a/docs/docs/guides/error-codes/_category_.json b/docs/docs/guides/error-codes/_category_.json deleted file mode 100644 index 245c91e98..000000000 --- a/docs/docs/guides/error-codes/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Error Codes", - "position": 7, - "link": { - "type": "generated-index", - "description": "List of Error Codes for Jan users" - } -} \ No newline at end of file diff --git a/docs/docs/guides/extensions/README.mdx b/docs/docs/guides/extensions/README.mdx new file mode 100644 index 000000000..fd8185b14 --- /dev/null +++ b/docs/docs/guides/extensions/README.mdx @@ -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"; + + diff --git a/docs/docs/guides/extensions/_category_.json b/docs/docs/guides/extensions/_category_.json deleted file mode 100644 index d4219c050..000000000 --- a/docs/docs/guides/extensions/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Extensions", - "position": 5, - "link": { - "type": "generated-index", - "description": "More info regarding Extensions for Jan" - } -} \ No newline at end of file diff --git a/docs/docs/guides/integration/README.mdx b/docs/docs/guides/integration/README.mdx new file mode 100644 index 000000000..1fc20ed66 --- /dev/null +++ b/docs/docs/guides/integration/README.mdx @@ -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"; + + diff --git a/docs/docs/guides/integration/_category_.json b/docs/docs/guides/integration/_category_.json deleted file mode 100644 index 1d11cbd4e..000000000 --- a/docs/docs/guides/integration/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Integrations", - "position": 6, - "link": { - "type": "generated-index", - "description": "More info regarding Jan.ai integrations" - } -} \ No newline at end of file diff --git a/docs/docs/guides/integration/azure.mdx b/docs/docs/guides/integration/azure.mdx index 94b7384e2..6c344a199 100644 --- a/docs/docs/guides/integration/azure.mdx +++ b/docs/docs/guides/integration/azure.mdx @@ -70,27 +70,9 @@ The [Azure OpenAI Service](https://learn.microsoft.com/en-us/azure/ai-services/o } ``` -### 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 +For more details regarding the `model.json` settings and parameters fields, please see [here](../models/integrate-remote.mdx#modeljson). +::: ### Step 3: Start the Model diff --git a/docs/docs/guides/integration/lmstudio.mdx b/docs/docs/guides/integration/lmstudio.mdx index 10eede3dd..33e48f33a 100644 --- a/docs/docs/guides/integration/lmstudio.mdx +++ b/docs/docs/guides/integration/lmstudio.mdx @@ -80,27 +80,9 @@ Replace `(port)` with your chosen port number. The default is 1234. "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 +For more details regarding the `model.json` settings and parameters fields, please see [here](../models/integrate-remote.mdx#modeljson). +::: ### Step 3: Starting the Model diff --git a/docs/docs/guides/integration/mistral.mdx b/docs/docs/guides/integration/mistral.mdx index 591da0d58..a44e23205 100644 --- a/docs/docs/guides/integration/mistral.mdx +++ b/docs/docs/guides/integration/mistral.mdx @@ -73,33 +73,11 @@ This tutorial demonstrates integrating Mistral AI with Jan using the API. "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 - -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. - +- 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. ::: ### Step 3: Start the Model diff --git a/docs/docs/guides/integration/ollama.mdx b/docs/docs/guides/integration/ollama.mdx index 333b06ae4..6c55bc856 100644 --- a/docs/docs/guides/integration/ollama.mdx +++ b/docs/docs/guides/integration/ollama.mdx @@ -79,27 +79,9 @@ ollama run "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 +For more details regarding the `model.json` settings and parameters fields, please see [here](../models/integrate-remote.mdx#modeljson). +::: ### Step 3: Start the Model 1. Restart Jan and navigate to the **Hub**. diff --git a/docs/docs/guides/integration/openrouter.mdx b/docs/docs/guides/integration/openrouter.mdx index e27bb1335..2189db0d9 100644 --- a/docs/docs/guides/integration/openrouter.mdx +++ b/docs/docs/guides/integration/openrouter.mdx @@ -49,27 +49,9 @@ To connect Jan with OpenRouter for accessing remote Large Language Models (LLMs) } ``` -### 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 +For more details regarding the `model.json` settings and parameters fields, please see [here](../models/integrate-remote.mdx#modeljson). +::: ### Step 3 : Start the Model 1. Restart Jan and go to the **Hub**. diff --git a/docs/docs/guides/models/README.mdx b/docs/docs/guides/models/README.mdx new file mode 100644 index 000000000..941eab3b6 --- /dev/null +++ b/docs/docs/guides/models/README.mdx @@ -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"; + + diff --git a/docs/docs/guides/models/_category_.json b/docs/docs/guides/models/_category_.json deleted file mode 100644 index d833e512b..000000000 --- a/docs/docs/guides/models/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Advanced Models Setup", - "position": 5, - "link": { - "type": "generated-index", - "description": "More info regarding AI models for Jan" - } -} \ No newline at end of file