From f08eacb0779d4d514500d96c36606c7ecec13e69 Mon Sep 17 00:00:00 2001 From: Arista Indrajaya Date: Thu, 7 Mar 2024 18:24:25 +0700 Subject: [PATCH 1/9] docs: Add a highlight category for each Menu groups. --- docs/sidebars.js | 74 +++++++++++++++++++++++++++++++++++++++-- docs/src/css/custom.css | 15 +++++++++ 2 files changed, 87 insertions(+), 2 deletions(-) diff --git a/docs/sidebars.js b/docs/sidebars.js index fb14f0abe3..dea87cd9e6 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -150,10 +150,80 @@ const sidebars = { ], }, ], + // guidesSidebar: [ + // { + // type: "autogenerated", + // dirName: "guides", + // }, + // ], guidesSidebar: [ { - type: "autogenerated", - dirName: "guides", + type: "category", + label: "Get Started", + collapsible: false, + className: "head_Menu", + items: [ + "guides/quickstart", + "guides/install", + "guides/start-server", + "guides/models-list" + ] + }, + { + type: "category", + label: "Guides", + collapsible: false, + className: "head_Menu", + items: [ + "guides/best-practices", + "guides/thread", + "guides/faq", + "guides/hardware-requiement", + ] + }, + { + type: "category", + label: "Advanced Features", + collapsible: false, + className: "head_Menu", + items: [ + "guides/models/README", + "guides/models/customize-engine", + "guides/models/import-models", + "guides/models/integrate-remote", + "guides/extensions/README", + "guides/extensions/import-ext", + "guides/extensions/setup-ext", + "guides/integration/README", + "guides/integration/azure", + "guides/integration/discord", + "guides/integration/groq", + "guides/integration/lmstudio", + "guides/integration/mistral", + "guides/integration/ollama", + "guides/integration/openinterpreter", + "guides/integration/openrouter", + "guides/integration/raycast", + "guides/integration/vscode", + ] + }, + { + type: "category", + label: "Troubleshooting", + collapsible: false, + className: "head_Menu", + items: [ + "guides/common-error/README", + "guides/common-error/broken-build", + "guides/common-error/not-using-gpu", + "guides/error-codes/README", + "guides/error-codes/how-to-get-error-logs", + "guides/error-codes/permission-denied", + "guides/error-codes/something-amiss", + "guides/error-codes/undefined-issue", + "guides/error-codes/unexpected-token", + "guides/faq" + ] }, ], developerSidebar: [ diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css index 9ed8fd0d86..5307bec2eb 100644 --- a/docs/src/css/custom.css +++ b/docs/src/css/custom.css @@ -6,3 +6,18 @@ [data-theme="dark"] .DocSearch { --docsearch-hit-active-color: #090a11; /* Keep the color unchanged */ } + +/* sidebarStyles.css */ +.head_Menu div { + font-weight: bold; + background-color: whitesmoke; + margin-left: 0.7rem; + font-size: larger; +} + +.head_Menu li { + /* Custom styles for the sidebar items */ + font-weight: normal; + background-color: white; + margin-bottom: 5px; /* Adjust margin as needed */ +} \ No newline at end of file From 751c273cde8a5f67a82350e7a79677a9ea052bdd Mon Sep 17 00:00:00 2001 From: Arista Indrajaya Date: Thu, 7 Mar 2024 18:24:56 +0700 Subject: [PATCH 2/9] docs: Add content Groq integration --- docs/docs/guides/integration/groq.mdx | 84 +++++++++++++++++++++++++++ 1 file changed, 84 insertions(+) create mode 100644 docs/docs/guides/integration/groq.mdx diff --git a/docs/docs/guides/integration/groq.mdx b/docs/docs/guides/integration/groq.mdx new file mode 100644 index 0000000000..a3a12dbc51 --- /dev/null +++ b/docs/docs/guides/integration/groq.mdx @@ -0,0 +1,84 @@ +--- +title: Groq +sidebar_position: 10 +slug: /guides/integration/groq +description: Learn how to integrate Groq API with Jan for enhanced functionality. +keywords: + [ + Groq API, + Jan, + Jan AI, + ChatGPT alternative, + conversational AI, + large language model, + integration, + Groq integration, + API integration + ] +--- + +## How to Integrate Mistral AI with Jan + +This guide provides step-by-step instructions on integrating the Groq API with Jan, enabling users to leverage Groq's capabilities within Jan's conversational interface. + +Before proceeding, ensure you have the following: +- Access to the Jan platform +- Groq API credentials + +## Integration Steps + +### Step 1: Obtain Groq API Credentials + +If you haven't already, sign up for the Groq API and obtain your API credentials. +Obtain Groq API keys from your [Groq Console](https://console.groq.com/keys). + +### Step 2: Configure Jan Settings + +1. Insert the Groq AI API key into `~/jan/engines/openai.json`. + +```json title="~/jan/engines/openai.json" +{ + "full_url": "https://api.groq.com/openai/v1", + "api_key": "" +} +``` + +### Step 3: Enable Groq Integration + +To set up the configuration for Groq in Jan, follow these steps: + +1. Navigate to `~/jan/models`. +2. Create a folder named `groq`. +3. Inside the groq folder, create a model.json file with the specified settings: +```json title="~/jan/models/groq/model.json +{ + "id": "groq", + "object": "model", + "name": "Groq Integration", + "version": "1.0", + "description": "Integration with Groq API for enhanced functionality.", + "format": "api", + "sources": [], + "settings": {}, + "parameters": {}, + "metadata": { + "author": "Your Name", + "tags": ["Groq Integration"] + }, + "engine": "groq" +} +``` + +### Step 4: Start the Model + +1. Restart Jan and navigate to the **Hub**. +2. Locate your model and click the **Use** button. + +## Troubleshooting + +If you encounter any issues during the integration process or while using Groq with Jan, consider the following troubleshooting steps: + +- Double-check your API credentials and ensure they are correctly entered. +- Verify that the Groq integration is enabled within Jan's settings. +- Check for any error messages or logs that may provide insight into the issue. +- Reach out to Groq API support for assistance if needed. \ No newline at end of file From 7d988cc2d9c048049292457910fa16f01d32d9a9 Mon Sep 17 00:00:00 2001 From: Arista Indrajaya Date: Thu, 7 Mar 2024 18:25:08 +0700 Subject: [PATCH 3/9] docs: Add FAQs content --- docs/docs/guides/faq.mdx | 80 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 77 insertions(+), 3 deletions(-) diff --git a/docs/docs/guides/faq.mdx b/docs/docs/guides/faq.mdx index 2a79e9fde2..d25b0f980b 100644 --- a/docs/docs/guides/faq.mdx +++ b/docs/docs/guides/faq.mdx @@ -17,6 +17,80 @@ keywords: ] --- -:::caution -This is currently under development. -::: \ No newline at end of file +## General Issues + +- **Why can't I download models like Pandora 11B Q4 and Solar Instruct 10.7B Q4?** + - These models might have been removed or taken down. Please check the [Pre-configured Models](models-list.mdx) for the latest updates on model availability. + +- **Why does Jan display "Apologies, something's amiss" when I try to run it?** + - This issue may arise if you're using an older Intel chip that does not fully support AVX instructions required for running AI models. Upgrading your hardware may resolve this issue. + +- **How can I use Jan in Russia?** + - To use Jan in Russia, a VPN or [HTTPS - Proxy](./advanced-settings/http-proxy.mdx) is recommended to bypass any regional restrictions that might be in place. + +- **I'm experiencing an error on startup from Nitro. What should I do?** + - If you encounter errors with Nitro, try switching the path to use the Nitro executable for the version 12-0. This adjustment can help resolve path-related issues. + +## Download and Installation Issues + +- **What does "Error occurred: Unexpected token" mean?** + - This error usually indicates a problem with your internet connection or that your access to certain resources is being blocked. Using a VPN or [HTTPS - Proxy](./advanced-settings/http-proxy.mdx) can help avoid these issues by providing a secure and unrestricted internet connection. + +- **Why aren't my downloads working?** + - If you're having trouble downloading directly through Jan, you might want to download the model separately and then import it into Jan. Detailed instructions are available on [here](install.mdx). + +- **Jan AI doesn't open on my Mac with an Intel processor. What can I do?** + - Granting the `.npm` folder permission for the user can resolve issues related to permissions on macOS, especially for users with Intel processors. + +- **What should I do if the model download freezes?** + - If a model download freezes, consider importing the models manually. You can find more detailed guidance on how to do this at [Manual Import](./models/import-models.mdx) article. + +- **I received a message that the model GPT4 does not exist or I do not have access. What should I do?** + - This message typically means you need to top up your credit with OpenAI or check your access permissions for the model. + +- **I can't download models from "Explore the Hub." What's the solution?** + - Uninstalling Jan, clearing the cache, and reinstalling it following the guide provided [here](install.mdx) may help. Also, consider downloading the `.gguf` model via a browser as an alternative approach. + +## Technical Issues and Solutions + +- **How can I download models with a socks5 proxy or import a local model file?** + - Nightly builds of Jan offer support for downloading models with socks5 proxies or importing local model files. + +- **My device shows no GPU usage and lacks a Settings folder. What should I do?** + - Using the nightly builds of Jan can address issues related to GPU usage and the absence of a Settings folder, as these builds contain the latest fixes and features. + +- **Why does Jan display a toast message saying a model is loaded when it is not actually loaded?** + - This issue can be resolved by downloading the `.gguf` file from Hugging Face and replacing it in the model folder. This ensures the correct model is loaded. + +- **How to enable CORS when running Nitro?** + - By default, CORS (Cross-Origin Resource Sharing) is disabled when running Nitro. Enabling CORS can be necessary for certain operations and integrations. Check the official documentation for instructions on how to enable CORS if your workflow requires it. + +## Compatibility and Support + +- **How to use GPU AMD for Jan?** + - Jan now supports AMD GPUs through Vulkan. This enhancement allows users with AMD graphics cards to leverage GPU acceleration, improving performance for AI model computations. + +- **Is Jan available for Android or iOS?** + - Jan is primarily focused on the Desktop app and does not currently offer mobile apps for Android or iOS. The development team is concentrating on enhancing the desktop experience. + +## Development and Features + +- **Can I use local files from my computer with Jan?** + - The feature to use local files is currently in development. For more information, please our offical [Discord](https://discord.com/invite/FTk2MvZwJH) for the latest update. + +- **Does Jan support Safetensors?** + - At the moment, Jan only supports GGUF. However, there are plans to support `.safetensor` files in the future. + +- **I hope to customize the installation path of each model. Is that possible?** + - Yes you can customize the installation path. Please see [here](https://github.com/janhq/jan/issues/1010) for more information. + +## Troubleshooting + +- **What should I do if there's high CPU usage while Jan is idle?** + - If you notice high CPU usage while Jan is idle, consider using the nightly builds of Jan + +- **What does the error "Failed to fetch" mean, and how can I fix it?** + - The "Failed to fetch" error typically occurs due to network issues or restrictions. Using the nightly builds of Jan may help overcome these issues by providing updated fixes and features. + +- **What should I do if "Failed to fetch" occurs using MacBook Pro with Intel HD Graphics 4000 1536 MB?** + - Ensure that the model size is less than 90% of your available VRAM and that the VRAM is accessible to the app. Managing the resources effectively can help mitigate this issue. From ca90b008c10d3ce3b78befe1aeeb662df7e1b1f8 Mon Sep 17 00:00:00 2001 From: Arista Indrajaya Date: Thu, 7 Mar 2024 18:50:30 +0700 Subject: [PATCH 4/9] docs: fix the sidebar issues --- docs/sidebars.js | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/sidebars.js b/docs/sidebars.js index dea87cd9e6..61bd854398 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -178,7 +178,6 @@ const sidebars = { "guides/best-practices", "guides/thread", "guides/faq", - "guides/hardware-requiement", ] }, { From 17181927a4456a2a2f35cf28b86b8e4f11bac587 Mon Sep 17 00:00:00 2001 From: Arista Indrajaya Date: Fri, 8 Mar 2024 14:12:50 +0700 Subject: [PATCH 5/9] docs: fix the navbar based on the latest feedback --- docs/sidebars.js | 105 +++++++++++++++++++++++++++++----------- docs/src/css/custom.css | 7 +++ 2 files changed, 84 insertions(+), 28 deletions(-) diff --git a/docs/sidebars.js b/docs/sidebars.js index 61bd854398..4c45cadbed 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -177,7 +177,6 @@ const sidebars = { items: [ "guides/best-practices", "guides/thread", - "guides/faq", ] }, { @@ -186,24 +185,54 @@ const sidebars = { collapsible: false, className: "head_Menu", items: [ - "guides/models/README", - "guides/models/customize-engine", - "guides/models/import-models", - "guides/models/integrate-remote", - "guides/extensions/README", - "guides/extensions/import-ext", - "guides/extensions/setup-ext", - "guides/integration/README", - "guides/integration/azure", - "guides/integration/discord", - "guides/integration/groq", - "guides/integration/lmstudio", - "guides/integration/mistral", - "guides/integration/ollama", - "guides/integration/openinterpreter", - "guides/integration/openrouter", - "guides/integration/raycast", - "guides/integration/vscode", + { + type: "category", + label: "Advanced Model Setup", + className: "head_SubMenu", + link: { + type: 'doc', + id: "guides/models/README", + }, + items: [ + "guides/models/customize-engine", + "guides/models/import-models", + "guides/models/integrate-remote", + ] + }, + { + type: "category", + label: "Extensions", + className: "head_SubMenu", + link: { + type: 'doc', + id: "guides/extensions/README", + }, + items: [ + "guides/extensions/import-ext", + "guides/extensions/setup-ext", + ] + }, + { + type: "category", + label: "Integrations", + className: "head_SubMenu", + link: { + type: 'doc', + id: "guides/integration/README", + }, + items: [ + "guides/integration/azure", + "guides/integration/discord", + "guides/integration/groq", + "guides/integration/lmstudio", + "guides/integration/mistral", + "guides/integration/ollama", + "guides/integration/openinterpreter", + "guides/integration/openrouter", + "guides/integration/raycast", + "guides/integration/vscode", + ] + }, ] }, { @@ -212,15 +241,35 @@ const sidebars = { collapsible: false, className: "head_Menu", items: [ - "guides/common-error/README", - "guides/common-error/broken-build", - "guides/common-error/not-using-gpu", - "guides/error-codes/README", - "guides/error-codes/how-to-get-error-logs", - "guides/error-codes/permission-denied", - "guides/error-codes/something-amiss", - "guides/error-codes/undefined-issue", - "guides/error-codes/unexpected-token", + { + type: "category", + label: "Error Codes", + className: "head_SubMenu", + link: { + type: 'doc', + id: "guides/error-codes/README", + }, + items: [ + "guides/error-codes/how-to-get-error-logs", + "guides/error-codes/permission-denied", + "guides/error-codes/something-amiss", + "guides/error-codes/undefined-issue", + "guides/error-codes/unexpected-token", + ] + }, + { + type: "category", + label: "Common Error", + className: "head_SubMenu", + link: { + type: 'doc', + id: "guides/common-error/README", + }, + items: [ + "guides/common-error/broken-build", + "guides/common-error/not-using-gpu", + ] + }, "guides/faq" ] }, diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css index 5307bec2eb..7d6bd33d2d 100644 --- a/docs/src/css/custom.css +++ b/docs/src/css/custom.css @@ -20,4 +20,11 @@ font-weight: normal; background-color: white; margin-bottom: 5px; /* Adjust margin as needed */ +} + +.head_SubMenu div { + font-weight: normal; + background-color: white; + margin-left: 0rem; + font-size: medium; } \ No newline at end of file From 74a72a1d6fb878774d676f633d9aa07c8ba7b202 Mon Sep 17 00:00:00 2001 From: Arista Indrajaya Date: Fri, 8 Mar 2024 14:13:07 +0700 Subject: [PATCH 6/9] docs: update Faq and guides integration content --- docs/docs/guides/faq.mdx | 11 +++++++---- docs/docs/guides/integration/groq.mdx | 10 +++++----- 2 files changed, 12 insertions(+), 9 deletions(-) diff --git a/docs/docs/guides/faq.mdx b/docs/docs/guides/faq.mdx index d25b0f980b..7e3d7d13d9 100644 --- a/docs/docs/guides/faq.mdx +++ b/docs/docs/guides/faq.mdx @@ -75,14 +75,11 @@ keywords: ## Development and Features -- **Can I use local files from my computer with Jan?** - - The feature to use local files is currently in development. For more information, please our offical [Discord](https://discord.com/invite/FTk2MvZwJH) for the latest update. - - **Does Jan support Safetensors?** - At the moment, Jan only supports GGUF. However, there are plans to support `.safetensor` files in the future. - **I hope to customize the installation path of each model. Is that possible?** - - Yes you can customize the installation path. Please see [here](https://github.com/janhq/jan/issues/1010) for more information. + - Yes you can customize the installation path. Please see [here](https://jan.ai/guides/advanced-settings/#access-the-jan-data-folder) for more information. ## Troubleshooting @@ -94,3 +91,9 @@ keywords: - **What should I do if "Failed to fetch" occurs using MacBook Pro with Intel HD Graphics 4000 1536 MB?** - Ensure that the model size is less than 90% of your available VRAM and that the VRAM is accessible to the app. Managing the resources effectively can help mitigate this issue. + +:::info[Assistance and Support] + +If you have questions, please join our [Discord community](https://discord.gg/Dt7MxDyNNZ) for support, updates, and discussions. + +::: \ No newline at end of file diff --git a/docs/docs/guides/integration/groq.mdx b/docs/docs/guides/integration/groq.mdx index a3a12dbc51..01eee1cb3c 100644 --- a/docs/docs/guides/integration/groq.mdx +++ b/docs/docs/guides/integration/groq.mdx @@ -22,7 +22,7 @@ keywords: This guide provides step-by-step instructions on integrating the Groq API with Jan, enabling users to leverage Groq's capabilities within Jan's conversational interface. Before proceeding, ensure you have the following: -- Access to the Jan platform +- Access to the Jan Application - Groq API credentials ## Integration Steps @@ -38,7 +38,7 @@ Obtain Groq API keys from your [Groq Console](https://console.groq.com/keys). ```json title="~/jan/engines/openai.json" { - "full_url": "https://api.groq.com/openai/v1", + "full_url": "https://api.groq.com/openai/v1/chat/completions", "api_key": "" } ``` @@ -52,7 +52,7 @@ To set up the configuration for Groq in Jan, follow these steps: 3. Inside the groq folder, create a model.json file with the specified settings: ```json title="~/jan/models/groq/model.json { - "id": "groq", + "id": "mixtral-8x7b-32768", "object": "model", "name": "Groq Integration", "version": "1.0", @@ -62,10 +62,10 @@ To set up the configuration for Groq in Jan, follow these steps: "settings": {}, "parameters": {}, "metadata": { - "author": "Your Name", + "author": "Mistral ", "tags": ["Groq Integration"] }, - "engine": "groq" + "engine": "openai" } ``` From d492207c7fedddc01a39f19bce8aef52512f9784 Mon Sep 17 00:00:00 2001 From: hieu-jan <150573299+hieu-jan@users.noreply.github.com> Date: Sat, 9 Mar 2024 19:40:44 +0900 Subject: [PATCH 7/9] docs: fix darkmode issue --- docs/src/css/custom.css | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css index 7d6bd33d2d..fd1f2b3847 100644 --- a/docs/src/css/custom.css +++ b/docs/src/css/custom.css @@ -1,3 +1,4 @@ +/* Hide descriptions in cards without a description */ .DocCardList--no-description .card p { display: none; } @@ -7,7 +8,7 @@ --docsearch-hit-active-color: #090a11; /* Keep the color unchanged */ } -/* sidebarStyles.css */ +/* Sidebar styles */ .head_Menu div { font-weight: bold; background-color: whitesmoke; @@ -16,10 +17,9 @@ } .head_Menu li { - /* Custom styles for the sidebar items */ font-weight: normal; background-color: white; - margin-bottom: 5px; /* Adjust margin as needed */ + margin-bottom: 5px; } .head_SubMenu div { @@ -27,4 +27,20 @@ background-color: white; margin-left: 0rem; font-size: medium; -} \ No newline at end of file +} + +/* Dark mode styles based on Docusaurus dark theme */ +[data-theme="dark"] .head_Menu div { + background-color: var(--ifm-background-color); + color: var(--ifm-font-color-base); +} + +[data-theme="dark"] .head_Menu li { + background-color: var(--ifm-background-color); + color: var(--ifm-font-color-base); +} + +[data-theme="dark"] .head_SubMenu div { + background-color: var(--ifm-background-color); + color: var(--ifm-font-color-base); +} From 6359364e2f89fa941f6c62ac39c6d83903698361 Mon Sep 17 00:00:00 2001 From: hieu-jan <150573299+hieu-jan@users.noreply.github.com> Date: Sat, 9 Mar 2024 19:42:11 +0900 Subject: [PATCH 8/9] docs: update groq integration --- docs/docs/guides/integration/groq.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/guides/integration/groq.mdx b/docs/docs/guides/integration/groq.mdx index 01eee1cb3c..a57bf16dd9 100644 --- a/docs/docs/guides/integration/groq.mdx +++ b/docs/docs/guides/integration/groq.mdx @@ -62,7 +62,7 @@ To set up the configuration for Groq in Jan, follow these steps: "settings": {}, "parameters": {}, "metadata": { - "author": "Mistral ", + "author": "Mistral", "tags": ["Groq Integration"] }, "engine": "openai" From 086f8b207e34eee21618a528c04262776e9cb3eb Mon Sep 17 00:00:00 2001 From: hieu-jan <150573299+hieu-jan@users.noreply.github.com> Date: Sat, 9 Mar 2024 19:46:35 +0900 Subject: [PATCH 9/9] docs: enhance css style --- docs/src/css/custom.css | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css index fd1f2b3847..4593f4f94f 100644 --- a/docs/src/css/custom.css +++ b/docs/src/css/custom.css @@ -4,43 +4,45 @@ } /* For dark theme */ -[data-theme="dark"] .DocSearch { +[data-theme='dark'] .DocSearch { --docsearch-hit-active-color: #090a11; /* Keep the color unchanged */ } - -/* Sidebar styles */ -.head_Menu div { +/* Sidebar styles based on Docusaurus light theme */ +[data-theme='light'] .head_Menu div { font-weight: bold; - background-color: whitesmoke; + background-color: var(--ifm-background-color); margin-left: 0.7rem; font-size: larger; + color: var(--ifm-font-color-base); } -.head_Menu li { +[data-theme='light'] .head_Menu li { font-weight: normal; - background-color: white; + background-color: var(--ifm-background-color); margin-bottom: 5px; + color: var(--ifm-font-color-base); } -.head_SubMenu div { +[data-theme='light'] .head_SubMenu div { font-weight: normal; - background-color: white; + background-color: var(--ifm-background-color); margin-left: 0rem; font-size: medium; + color: var(--ifm-font-color-base); } /* Dark mode styles based on Docusaurus dark theme */ -[data-theme="dark"] .head_Menu div { +[data-theme='dark'] .head_Menu div { background-color: var(--ifm-background-color); color: var(--ifm-font-color-base); } -[data-theme="dark"] .head_Menu li { +[data-theme='dark'] .head_Menu li { background-color: var(--ifm-background-color); color: var(--ifm-font-color-base); } -[data-theme="dark"] .head_SubMenu div { +[data-theme='dark'] .head_SubMenu div { background-color: var(--ifm-background-color); color: var(--ifm-font-color-base); }