diff --git a/README.md b/README.md index 31fa4bfc9..9e9d83fc9 100644 --- a/README.md +++ b/README.md @@ -327,6 +327,7 @@ Jan builds on top of other open-source projects: - [llama.cpp](https://github.com/ggerganov/llama.cpp) - [LangChain](https://github.com/langchain-ai) - [TensorRT](https://github.com/NVIDIA/TensorRT) +- [TensorRT-LLM](https://github.com/NVIDIA/TensorRT-LLM) ## Contact diff --git a/docs/docs/about/2035.mdx b/docs/docs/about/2035.mdx index 3af7a3197..2806e7ade 100644 --- a/docs/docs/about/2035.mdx +++ b/docs/docs/about/2035.mdx @@ -2,6 +2,20 @@ title: Jan's Vision for 2035 --- + + Jan's Vision for 2035 + + + + + + + + + + + + [Jan 2035: A Robotics Company](https://hackmd.io/QIWyYbNNQVWVbupuI3kjAA) We only have 2 planning parameters: diff --git a/docs/docs/about/about.md b/docs/docs/about/about.md index a047ab910..32f4a3e4f 100644 --- a/docs/docs/about/about.md +++ b/docs/docs/about/about.md @@ -18,6 +18,20 @@ keywords: ] --- + + About Jan + + + + + + + + + + + + Jan turns computers into thinking machines to change how we use them. Jan is created and maintained by Jan Labs, a robotics company. diff --git a/docs/docs/about/faq.md b/docs/docs/about/faq.md index 29832e211..b4e05b3a6 100644 --- a/docs/docs/about/faq.md +++ b/docs/docs/about/faq.md @@ -1,3 +1,21 @@ +--- +title: Frequently Asked Questions (FAQ) - Jan +--- + + + Frequently Asked Questions (FAQ) + + + + + + + + + + + + # Frequently Asked Questions (FAQ) ## What is Jan? diff --git a/docs/docs/about/roadmap.md b/docs/docs/about/roadmap.md index 1c789d733..d818aa647 100644 --- a/docs/docs/about/roadmap.md +++ b/docs/docs/about/roadmap.md @@ -2,5 +2,19 @@ title: Roadmap --- + + Roadmap + + + + + + + + + + + + - [ ] [Immediate Roadmap on Github](https://github.com/orgs/janhq/projects/5/views/16) -- [ ] [Longer-term Roadmap on Discord](https://discord.gg/Ey62mynnYr) \ No newline at end of file +- [ ] [Longer-term Roadmap on Discord](https://discord.gg/Ey62mynnYr) diff --git a/docs/docs/acknowledgements.md b/docs/docs/acknowledgements.md index c68c4ed86..a7f77218e 100644 --- a/docs/docs/acknowledgements.md +++ b/docs/docs/acknowledgements.md @@ -17,6 +17,18 @@ keywords: ] --- + + Acknowledgements - Jan + + + + + + + + + + # Acknowledgements We would like to express our gratitude to the following third-party libraries that have made the development of Jan possible. @@ -24,3 +36,4 @@ We would like to express our gratitude to the following third-party libraries th - [llama.cpp](https://github.com/ggerganov/llama.cpp/blob/master/LICENSE) - [LangChain.js](https://github.com/langchain-ai/langchainjs/blob/main/LICENSE) - [TensorRT](https://github.com/NVIDIA/TensorRT/blob/main/LICENSE) +- [TensorRT-LLM](https://github.com/NVIDIA/TensorRT-LLM/blob/main/LICENSE) diff --git a/docs/docs/community/community.mdx b/docs/docs/community/community.mdx index d4866490e..7c5ad9367 100644 --- a/docs/docs/community/community.mdx +++ b/docs/docs/community/community.mdx @@ -15,6 +15,20 @@ keywords: ] --- + + Jan's Community + + + + + + + + + + + + ## Socials - [Discord](https://discord.gg/SH3DGmUs6b) diff --git a/docs/docs/developer/02-build-assistant/01-your-first-assistant.md b/docs/docs/developer/02-build-assistant/01-your-first-assistant.md index 16b80fc5e..863d275fe 100644 --- a/docs/docs/developer/02-build-assistant/01-your-first-assistant.md +++ b/docs/docs/developer/02-build-assistant/01-your-first-assistant.md @@ -17,7 +17,20 @@ keywords: ] --- + + Your First Assistant + + + + + + + + + + + + :::caution This is currently under development. ::: - diff --git a/docs/docs/developer/05-framework/03-engineering/assistants.md b/docs/docs/developer/05-framework/03-engineering/assistants.md index fa9c593ab..90b52ab38 100644 --- a/docs/docs/developer/05-framework/03-engineering/assistants.md +++ b/docs/docs/developer/05-framework/03-engineering/assistants.md @@ -1,5 +1,5 @@ --- -title: "Assistants" +title: 'Assistants' description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. keywords: [ @@ -14,6 +14,19 @@ keywords: ] --- + + Assistants + + + + + + + + + + + :::caution This is currently under development. diff --git a/docs/docs/developer/05-framework/03-engineering/chats.md b/docs/docs/developer/05-framework/03-engineering/chats.md index eb0ae287a..654621e30 100644 --- a/docs/docs/developer/05-framework/03-engineering/chats.md +++ b/docs/docs/developer/05-framework/03-engineering/chats.md @@ -14,6 +14,19 @@ keywords: ] --- + + Chats + + + + + + + + + + + :::caution This is currently under development. diff --git a/docs/docs/developer/05-framework/03-engineering/engine.md b/docs/docs/developer/05-framework/03-engineering/engine.md index 653576f1b..8ebfff88d 100644 --- a/docs/docs/developer/05-framework/03-engineering/engine.md +++ b/docs/docs/developer/05-framework/03-engineering/engine.md @@ -2,6 +2,19 @@ title: Engine --- + + Engine + + + + + + + + + + + :::caution Currently Under Development diff --git a/docs/docs/developer/05-framework/03-engineering/files.md b/docs/docs/developer/05-framework/03-engineering/files.md index 59ca27ec9..9f572af11 100644 --- a/docs/docs/developer/05-framework/03-engineering/files.md +++ b/docs/docs/developer/05-framework/03-engineering/files.md @@ -1,5 +1,5 @@ --- -title: "Files" +title: 'Files' description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. keywords: [ @@ -14,6 +14,19 @@ keywords: ] --- + + Files + + + + + + + + + + + :::warning Draft Specification: functionality has not been implemented yet. diff --git a/docs/docs/developer/05-framework/03-engineering/messages.md b/docs/docs/developer/05-framework/03-engineering/messages.md index 8f2497002..6ddaba45d 100644 --- a/docs/docs/developer/05-framework/03-engineering/messages.md +++ b/docs/docs/developer/05-framework/03-engineering/messages.md @@ -14,6 +14,19 @@ keywords: ] --- + + Messages + + + + + + + + + + + :::caution This is currently under development. diff --git a/docs/docs/developer/05-framework/03-engineering/models.md b/docs/docs/developer/05-framework/03-engineering/models.md index 4e4c3c604..dbe134f07 100644 --- a/docs/docs/developer/05-framework/03-engineering/models.md +++ b/docs/docs/developer/05-framework/03-engineering/models.md @@ -14,6 +14,19 @@ keywords: ] --- + + Models + + + + + + + + + + + :::caution This is currently under development. diff --git a/docs/docs/developer/05-framework/03-engineering/threads.md b/docs/docs/developer/05-framework/03-engineering/threads.md index a1cd2b4df..f8ba018f8 100644 --- a/docs/docs/developer/05-framework/03-engineering/threads.md +++ b/docs/docs/developer/05-framework/03-engineering/threads.md @@ -14,6 +14,19 @@ keywords: ] --- + + Threads + + + + + + + + + + + :::caution This is currently under development. diff --git a/docs/docs/developer/05-framework/03-product/chat.md b/docs/docs/developer/05-framework/03-product/chat.md index b0dcce2d6..3b98485b8 100644 --- a/docs/docs/developer/05-framework/03-product/chat.md +++ b/docs/docs/developer/05-framework/03-product/chat.md @@ -14,6 +14,19 @@ keywords: ] --- + + Chat + + + + + + + + + + + ## Overview A home screen for users to chat with [assistants](/docs/engineering/assistants) via conversation [threads](/docs/engineering/threads). diff --git a/docs/docs/developer/05-framework/03-product/hub.md b/docs/docs/developer/05-framework/03-product/hub.md index 7171f8378..ea8dd81a5 100644 --- a/docs/docs/developer/05-framework/03-product/hub.md +++ b/docs/docs/developer/05-framework/03-product/hub.md @@ -14,6 +14,19 @@ keywords: ] --- + + Hub + + + + + + + + + + + ## Overview The Hub is like a store for everything, where users can discover and download models, assistants, and more. diff --git a/docs/docs/developer/05-framework/03-product/jan.md b/docs/docs/developer/05-framework/03-product/jan.md index 9e8973360..b906be09d 100644 --- a/docs/docs/developer/05-framework/03-product/jan.md +++ b/docs/docs/developer/05-framework/03-product/jan.md @@ -14,6 +14,19 @@ keywords: ] --- + + Jan (The Default Assistant) + + + + + + + + + + + Jan ships with a default assistant "Jan" that lets users chat with any open source model out-of-the-box. This assistant is defined in `/jan`. It is a generic assistant to illustrate power of Jan. In the future, it will support additional features e.g. multi-assistant conversations diff --git a/docs/docs/developer/05-framework/03-product/settings.md b/docs/docs/developer/05-framework/03-product/settings.md index 514139a00..515b5e802 100644 --- a/docs/docs/developer/05-framework/03-product/settings.md +++ b/docs/docs/developer/05-framework/03-product/settings.md @@ -14,6 +14,19 @@ keywords: ] --- + + Settings + + + + + + + + + + + ## Overview A settings page for users to add extensions, configure model settings, change app appearance, add keyboard shortcuts, and a plethora of other personalizations. diff --git a/docs/docs/developer/05-framework/03-product/system-monitor.md b/docs/docs/developer/05-framework/03-product/system-monitor.md index 761d9a7bf..15dae09ea 100644 --- a/docs/docs/developer/05-framework/03-product/system-monitor.md +++ b/docs/docs/developer/05-framework/03-product/system-monitor.md @@ -14,6 +14,19 @@ keywords: ] --- + + System Monitor + + + + + + + + + + + ## Overview An activity screen to monitor system health and running models. diff --git a/docs/docs/events/hcmc-oct23.md b/docs/docs/events/hcmc-oct23.md index 73898efcd..e70329b2d 100644 --- a/docs/docs/events/hcmc-oct23.md +++ b/docs/docs/events/hcmc-oct23.md @@ -1,10 +1,23 @@ --- title: "Jan's AI Hacker House (Ho Chi Minh City)" -description: "24-27 Oct 2023, District 3, HCMC. AI-focused talks, workshops and social events. Hosted by Jan.ai" +description: '24-27 Oct 2023, District 3, HCMC. AI-focused talks, workshops and social events. Hosted by Jan.ai' slug: /events/hcmc-oct23 image: /img/hcmc-launch-party.png --- + + Jan's AI Hacker House (Ho Chi Minh City) + + + + + + + + + + + ![](/img/hcmc-launch-party.png) 🎉 Join us at our Friday Launch Party for an evening of AI talks from other builders! [(RSVP here)](https://jan-launch-party.eventbrite.sg/) 🎉 diff --git a/docs/docs/events/nvidia-llm-day-nov-23.md b/docs/docs/events/nvidia-llm-day-nov-23.md index d467dcb6e..f739fb4ff 100644 --- a/docs/docs/events/nvidia-llm-day-nov-23.md +++ b/docs/docs/events/nvidia-llm-day-nov-23.md @@ -1,21 +1,33 @@ --- -title: "Nov 23: Nvidia GenAI Day" -description: Nvidia's LLM Day +title: 'Nov 23: Nvidia GenAI Day' +description: Nvidia's LLM Day --- + + Nov 23: Nvidia GenAI Day + + + + + + + + + + + ![](/img/nvidia-llm-day-header.png) ## Nvidia GenAI Innovation Day -Jan will be at Nvidia's GenAI Innovation Day in Nov '23, focusing on Enterprise use-cases of LLMs. +Jan will be at Nvidia's GenAI Innovation Day in Nov '23, focusing on Enterprise use-cases of LLMs. ### Location -- JW Marriott Hanoi Hotel +- JW Marriott Hanoi Hotel - 8:30am November 8th 2023 - Registration: [https://gmcgroup.com.vn/nvidia-genai-event/](https://gmcgroup.com.vn/nvidia-genai-event/) ### Programme ![](/img/nvidia-llm-day.png) - diff --git a/docs/docs/guides/advanced-settings/advanced-settings.mdx b/docs/docs/guides/advanced-settings/advanced-settings.mdx index ae3244cda..1ce65867a 100644 --- a/docs/docs/guides/advanced-settings/advanced-settings.mdx +++ b/docs/docs/guides/advanced-settings/advanced-settings.mdx @@ -15,6 +15,20 @@ keywords: ] --- + + Advanced Settings + + + + + + + + + + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/docs/guides/advanced-settings/http-proxy.mdx b/docs/docs/guides/advanced-settings/http-proxy.mdx index 7b2de339c..297133aae 100644 --- a/docs/docs/guides/advanced-settings/http-proxy.mdx +++ b/docs/docs/guides/advanced-settings/http-proxy.mdx @@ -16,6 +16,19 @@ keywords: ] --- + + HTTPS Proxy + + + + + + + + + + + ## Why HTTPS Proxy? diff --git a/docs/docs/guides/best-practices.mdx b/docs/docs/guides/best-practices.mdx index 9dabef8dc..d6e8c4584 100644 --- a/docs/docs/guides/best-practices.mdx +++ b/docs/docs/guides/best-practices.mdx @@ -17,6 +17,18 @@ keywords: ] --- + + Best Practices - Jan Guides + + + + + + + + + + Jan is a versatile platform offering solutions for integrating AI locally across various platforms. This guide outlines best practices for developers, analysts, and AI enthusiasts to enhance their experience with Jan when adding AI locally to their computers. Implementing these practices will optimize the performance of AI models. ## Follow the Quickstart Guide diff --git a/docs/docs/guides/common-error/broken-build.mdx b/docs/docs/guides/common-error/broken-build.mdx index 2b3e7a128..9a8809955 100644 --- a/docs/docs/guides/common-error/broken-build.mdx +++ b/docs/docs/guides/common-error/broken-build.mdx @@ -17,6 +17,20 @@ keywords: ] --- + + Broken Build + + + + + + + + + + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/docs/guides/common-error/not-using-gpu.mdx b/docs/docs/guides/common-error/not-using-gpu.mdx index a7dd788f8..b932a6822 100644 --- a/docs/docs/guides/common-error/not-using-gpu.mdx +++ b/docs/docs/guides/common-error/not-using-gpu.mdx @@ -17,6 +17,20 @@ keywords: [ ] --- + + Troubleshooting NVIDIA GPU + + + + + + + + + + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/docs/guides/error-codes/how-to-get-error-logs.mdx b/docs/docs/guides/error-codes/how-to-get-error-logs.mdx index 045468e33..74a7508c0 100644 --- a/docs/docs/guides/error-codes/how-to-get-error-logs.mdx +++ b/docs/docs/guides/error-codes/how-to-get-error-logs.mdx @@ -17,6 +17,20 @@ keywords: ] --- + + How to Get Error Logs + + + + + + + + + + + + To get the error logs of your Jan application, follow the steps below: ### Jan Application 1. Navigate to the main dashboard. diff --git a/docs/docs/guides/error-codes/no-assistant-available.mdx b/docs/docs/guides/error-codes/no-assistant-available.mdx index 31d9a75e9..7716dc5b0 100644 --- a/docs/docs/guides/error-codes/no-assistant-available.mdx +++ b/docs/docs/guides/error-codes/no-assistant-available.mdx @@ -17,6 +17,20 @@ keywords: ] --- + + No Assistant Available + + + + + + + + + + + + When you encounter the following error message: ``` No assistant available. diff --git a/docs/docs/guides/error-codes/something-amiss.mdx b/docs/docs/guides/error-codes/something-amiss.mdx index 0975754e3..63f918441 100644 --- a/docs/docs/guides/error-codes/something-amiss.mdx +++ b/docs/docs/guides/error-codes/something-amiss.mdx @@ -4,6 +4,18 @@ sidebar_position: 4 description: A step-by-step guide to resolve an unspecified or general error. --- + + Something's Amiss + + + + + + + + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/docs/guides/error-codes/stuck-on-loading-model.mdx b/docs/docs/guides/error-codes/stuck-on-loading-model.mdx index 86a16b5fc..3c5adf035 100644 --- a/docs/docs/guides/error-codes/stuck-on-loading-model.mdx +++ b/docs/docs/guides/error-codes/stuck-on-loading-model.mdx @@ -17,6 +17,18 @@ keywords: ] --- + + Stuck on Loading Model + + + + + + + + + + ## 1. Issue: Model Loading Stuck Due To Missing Windows Management Instrumentation Command-line (WMIC) Encountering a stuck-on-loading model issue in Jan is caused by errors related to the `Windows Management Instrumentation Command-line (WMIC)` path not being included in the system's PATH environment variable. diff --git a/docs/docs/guides/error-codes/thread-disappreance.mdx b/docs/docs/guides/error-codes/thread-disappreance.mdx index 06235df56..120e8585c 100644 --- a/docs/docs/guides/error-codes/thread-disappreance.mdx +++ b/docs/docs/guides/error-codes/thread-disappreance.mdx @@ -17,6 +17,18 @@ keywords: ] --- + + Thread Disappearance + + + + + + + + + + When you encounter the error of old threads suddenly disappear. This can happen when a new, unintentional file is created in `/jan/threads`. It can be resolved through the following steps: diff --git a/docs/docs/guides/error-codes/undefined-issue.mdx b/docs/docs/guides/error-codes/undefined-issue.mdx index 223f686d1..9373044a4 100644 --- a/docs/docs/guides/error-codes/undefined-issue.mdx +++ b/docs/docs/guides/error-codes/undefined-issue.mdx @@ -17,6 +17,18 @@ keywords: ] --- + + Undefined Issue + + + + + + + + + + Encountering an `undefined issue` in Jan is caused by errors related to the Nitro tool or other internal processes. It can be resolved through the following steps: 1. Clearing the Jan folder and then reopen the application to determine if the problem persists diff --git a/docs/docs/guides/error-codes/unexpected-token.mdx b/docs/docs/guides/error-codes/unexpected-token.mdx index 4a00e447d..252cd97fa 100644 --- a/docs/docs/guides/error-codes/unexpected-token.mdx +++ b/docs/docs/guides/error-codes/unexpected-token.mdx @@ -17,6 +17,18 @@ keywords: ] --- + + Unexpected Token + + + + + + + + + + Encountering the `Unexpected token` error when initiating a chat with OpenAI models mainly caused by either your OpenAI key or where you access your OpenAI from. This issue can be solved through the following steps: 1. Obtain an OpenAI API key from [OpenAI's developer platform](https://platform.openai.com/) and integrate it into your application. diff --git a/docs/docs/guides/faq.mdx b/docs/docs/guides/faq.mdx index 7e3d7d13d..862d43620 100644 --- a/docs/docs/guides/faq.mdx +++ b/docs/docs/guides/faq.mdx @@ -17,6 +17,18 @@ keywords: ] --- + + FAQs - Jan Guides + + + + + + + + + + ## General Issues - **Why can't I download models like Pandora 11B Q4 and Solar Instruct 10.7B Q4?** diff --git a/docs/docs/guides/install.mdx b/docs/docs/guides/install.mdx index c8dcbf3c3..11fc96685 100644 --- a/docs/docs/guides/install.mdx +++ b/docs/docs/guides/install.mdx @@ -16,6 +16,18 @@ keywords: ] --- + + Installation - Jan Guides + + + + + + + + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import installImageURL from './assets/jan-ai-download.png'; diff --git a/docs/docs/guides/integration/azure.mdx b/docs/docs/guides/integration/azure.mdx index 6c344a199..24f457d28 100644 --- a/docs/docs/guides/integration/azure.mdx +++ b/docs/docs/guides/integration/azure.mdx @@ -17,6 +17,18 @@ keywords: ] --- + + Azure OpenAI + + + + + + + + + + ## How to Integrate Azure OpenAI with Jan The [Azure OpenAI Service](https://learn.microsoft.com/en-us/azure/ai-services/openai/overview?source=docs) offers robust APIs, making it simple for you to incorporate OpenAI's language models into your applications. You can integrate Azure OpenAI with Jan by following the steps below: diff --git a/docs/docs/guides/integration/discord.mdx b/docs/docs/guides/integration/discord.mdx index 5cf846883..7b91cc972 100644 --- a/docs/docs/guides/integration/discord.mdx +++ b/docs/docs/guides/integration/discord.mdx @@ -4,6 +4,18 @@ sidebar_position: 5 description: A step-by-step guide on how to integrate Jan with a Discord bot. --- + + Discord + + + + + + + + + + ## How to Integrate Discord Bot with Jan Discord bot can enhances your discord server interactions. By integrating Jan with it, you can significantly boost responsiveness and user engaggement in your discord server. diff --git a/docs/docs/guides/integration/groq.mdx b/docs/docs/guides/integration/groq.mdx index a57bf16dd..2edc1caa5 100644 --- a/docs/docs/guides/integration/groq.mdx +++ b/docs/docs/guides/integration/groq.mdx @@ -17,6 +17,18 @@ keywords: ] --- + + Groq + + + + + + + + + + ## 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. diff --git a/docs/docs/guides/integration/lmstudio.mdx b/docs/docs/guides/integration/lmstudio.mdx index 33e48f33a..9b018c2a7 100644 --- a/docs/docs/guides/integration/lmstudio.mdx +++ b/docs/docs/guides/integration/lmstudio.mdx @@ -16,6 +16,18 @@ keywords: ] --- + + LM Studio + + + + + + + + + + ## How to Integrate LM Studio with Jan [LM Studio](https://lmstudio.ai/) enables you to explore, download, and run local Large Language Models (LLMs). You can integrate Jan with LM Studio using two methods: diff --git a/docs/docs/guides/integration/mistral.mdx b/docs/docs/guides/integration/mistral.mdx index a44e23205..1772fefd9 100644 --- a/docs/docs/guides/integration/mistral.mdx +++ b/docs/docs/guides/integration/mistral.mdx @@ -16,6 +16,18 @@ keywords: ] --- + + Mistral AI + + + + + + + + + + ## How to Integrate Mistral AI with Jan [Mistral AI](https://docs.mistral.ai/) provides two ways to use their Large Language Models (LLM): diff --git a/docs/docs/guides/integration/ollama.mdx b/docs/docs/guides/integration/ollama.mdx index 6c55bc856..e50431f79 100644 --- a/docs/docs/guides/integration/ollama.mdx +++ b/docs/docs/guides/integration/ollama.mdx @@ -16,6 +16,18 @@ keywords: ] --- + + Ollama + + + + + + + + + + ## How to Integrate Ollama with Jan Ollama provides you with largen language that you can run locally. There are two methods to integrate Ollama with Jan: diff --git a/docs/docs/guides/integration/openinterpreter.mdx b/docs/docs/guides/integration/openinterpreter.mdx index a844155f5..ff706a3bc 100644 --- a/docs/docs/guides/integration/openinterpreter.mdx +++ b/docs/docs/guides/integration/openinterpreter.mdx @@ -4,6 +4,17 @@ sidebar_position: 6 description: A step-by-step guide on how to integrate Jan with Open Interpreter. --- + + Open Interpreter + + + + + + + + + ## How to Integrate Open Interpreter with Jan diff --git a/docs/docs/guides/integration/openrouter.mdx b/docs/docs/guides/integration/openrouter.mdx index 2189db0d9..89e90c6d5 100644 --- a/docs/docs/guides/integration/openrouter.mdx +++ b/docs/docs/guides/integration/openrouter.mdx @@ -4,6 +4,17 @@ sidebar_position: 2 description: A step-by-step guide on how to integrate Jan with OpenRouter. --- + + OpenRouter + + + + + + + + + ## How to Integrate OpenRouter with Jan @@ -16,7 +27,7 @@ To connect Jan with OpenRouter for accessing remote Large Language Models (LLMs) 1. Find your API keys in the [OpenRouter API Key](https://openrouter.ai/keys). 2. Set the OpenRouter API key in `~/jan/engines/openai.json` file. -### Step 2: MModel Configuration +### Step 2: Model Configuration 1. Go to the directory `~/jan/models`. 2. Make a new folder called `openrouter-(modelname)`, like `openrouter-dolphin-mixtral-8x7b`. diff --git a/docs/docs/guides/integration/raycast.mdx b/docs/docs/guides/integration/raycast.mdx index a626b0061..c9cb092b7 100644 --- a/docs/docs/guides/integration/raycast.mdx +++ b/docs/docs/guides/integration/raycast.mdx @@ -4,6 +4,17 @@ sidebar_position: 4 description: A step-by-step guide on how to integrate Jan with Raycast. --- + + Raycast + + + + + + + + + ## How to Integrate Raycast [Raycast](https://www.raycast.com/) is a productivity tool designed for macOS that enhances workflow efficiency by providing quick access to various tasks and functionalities through a keyboard-driven interface. To integrate Raycast with Jan, follow the steps below: diff --git a/docs/docs/guides/integration/vscode.mdx b/docs/docs/guides/integration/vscode.mdx index 0bc112186..e40f91a78 100644 --- a/docs/docs/guides/integration/vscode.mdx +++ b/docs/docs/guides/integration/vscode.mdx @@ -17,6 +17,18 @@ keywords: ] --- + + Continue + + + + + + + + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/docs/guides/models-list.mdx b/docs/docs/guides/models-list.mdx index cd7107a92..149d73733 100644 --- a/docs/docs/guides/models-list.mdx +++ b/docs/docs/guides/models-list.mdx @@ -3,6 +3,18 @@ title: Pre-configured Models sidebar_position: 3 --- + + Pre-configured Models - Jan Guides + + + + + + + + + + ## Overview Jan provides various pre-configured AI models with different capabilities. Please see the following list for details. diff --git a/docs/docs/guides/models/customize-engine.mdx b/docs/docs/guides/models/customize-engine.mdx index 2f54204a8..440e02243 100644 --- a/docs/docs/guides/models/customize-engine.mdx +++ b/docs/docs/guides/models/customize-engine.mdx @@ -17,6 +17,18 @@ keywords: ] --- + + Customize Engine Settings + + + + + + + + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/docs/guides/models/import-models.mdx b/docs/docs/guides/models/import-models.mdx index 9ed8953c7..a1f333db8 100644 --- a/docs/docs/guides/models/import-models.mdx +++ b/docs/docs/guides/models/import-models.mdx @@ -17,6 +17,18 @@ keywords: ] --- + + Manual Import + + + + + + + + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import janModel from './assets/jan-model-hub.png'; diff --git a/docs/docs/guides/models/integrate-remote.mdx b/docs/docs/guides/models/integrate-remote.mdx index af881f999..c99d7b98f 100644 --- a/docs/docs/guides/models/integrate-remote.mdx +++ b/docs/docs/guides/models/integrate-remote.mdx @@ -18,6 +18,18 @@ keywords: ] --- + + Remote Server Integration + + + + + + + + + + This guide will show you how to configure Jan as a client and point it to any remote & local (self-hosted) API server. ## OpenAI Platform Configuration diff --git a/docs/docs/guides/providers/llama-cpp.md b/docs/docs/guides/providers/llama-cpp.md index d2b0daa2a..8d9db5398 100644 --- a/docs/docs/guides/providers/llama-cpp.md +++ b/docs/docs/guides/providers/llama-cpp.md @@ -3,8 +3,20 @@ title: llama.cpp slug: /guides/providers/llama-cpp --- + + llama.cpp - Jan Guides + + + + + + + + + + ## Overview [Nitro](https://github.com/janhq/nitro) is an inference server on top of [llama.cpp](https://github.com/ggerganov/llama.cpp). It provides an OpenAI-compatible API, queue, & scaling. -Nitro is the default AI engine downloaded with Jan. There is no additional setup needed. \ No newline at end of file +Nitro is the default AI engine downloaded with Jan. There is no additional setup needed. diff --git a/docs/docs/guides/providers/tensorrt-llm.md b/docs/docs/guides/providers/tensorrt-llm.md index 52da83b36..b30d3510f 100644 --- a/docs/docs/guides/providers/tensorrt-llm.md +++ b/docs/docs/guides/providers/tensorrt-llm.md @@ -3,11 +3,23 @@ title: TensorRT-LLM slug: /guides/providers/tensorrt-llm --- + + TensorRT-LLM - Jan Guides + + + + + + + + + + Users with Nvidia GPUs can get **20-40% faster\* token speeds** on their laptop or desktops by using [TensorRT-LLM](https://github.com/NVIDIA/TensorRT-LLM). The greater implication is that you are running FP16, which is also more accurate than quantized models. This guide walks you through how to install Jan's official [TensorRT-LLM Extension](https://github.com/janhq/nitro-tensorrt-llm). This extension uses [Nitro-TensorRT-LLM](https://github.com/janhq/nitro-tensorrt-llm) as the AI engine, instead of the default [Nitro-Llama-CPP](https://github.com/janhq/nitro). It includes an efficient C++ server to natively execute the [TRT-LLM C++ runtime](https://nvidia.github.io/TensorRT-LLM/gpt_runtime.html). It also comes with additional feature and performance improvements like OpenAI compatibility, tokenizer improvements, and queues. -*Compared to using LlamaCPP engine. +\*Compared to using LlamaCPP engine. :::warning This feature is only available for Windows users. Linux is coming soon. @@ -37,6 +49,7 @@ ls ~\jan\extensions\@janhq\tensorrt-llm-extension\dist\bin ``` ## Download a Compatible Model + TensorRT-LLM can only run models in `TensorRT` format. These models, aka "TensorRT Engines", are prebuilt specifically for each target OS+GPU architecture. We offer a handful of precompiled models for Ampere and Ada cards that you can immediately download and play with: @@ -47,7 +60,7 @@ We offer a handful of precompiled models for Ampere and Ada cards that you can i ![image](https://hackmd.io/_uploads/rJewrEgRp.png) 3. Click use and start chatting! -4. You may need to allow Nitro in your network +4. You may need to allow Nitro in your network ![alt text](image.png) @@ -57,7 +70,7 @@ If you are our nightly builds, you may have to reinstall the TensorRT-LLM extens ## Configure Settings -You can customize the default parameters for how Jan runs TensorRT-LLM. +You can customize the default parameters for how Jan runs TensorRT-LLM. :::info coming soon diff --git a/docs/docs/guides/quickstart.mdx b/docs/docs/guides/quickstart.mdx index 84612716a..4ef86b589 100644 --- a/docs/docs/guides/quickstart.mdx +++ b/docs/docs/guides/quickstart.mdx @@ -16,6 +16,18 @@ keywords: ] --- + + Quickstart - Jan Docs + + + + + + + + + + import installImageURL from './assets/jan-ai-quickstart.png'; import flow from './assets/quick.png'; diff --git a/docs/docs/guides/start-server.mdx b/docs/docs/guides/start-server.mdx index d293bc646..2ae72c92b 100644 --- a/docs/docs/guides/start-server.mdx +++ b/docs/docs/guides/start-server.mdx @@ -4,6 +4,17 @@ sidebar_position: 4 description: A step-by-step guide to start Jan Local Server. --- + + Local Server - Jan Docs + + + + + + + + + Jan provides a built-in API server that can be used as a drop-in for OpenAI's API local replacement. This guide will walk you through on how to start the local server and use it to make request to the local server. diff --git a/docs/docs/guides/thread.mdx b/docs/docs/guides/thread.mdx index fdd8fb603..57f036bef 100644 --- a/docs/docs/guides/thread.mdx +++ b/docs/docs/guides/thread.mdx @@ -5,6 +5,17 @@ hide_table_of_contents: true description: Manage your interaction with AI locally. --- + + Thread Management - Jan Docs + + + + + + + + + Jan provides a straightforward and private solution for managing your threads with AI on your own device. As you interact with AI using Jan, you'll accumulate a history of threads. Jan offers easy tools to organize, delete, or review your past threads with AI. This guide will show you how to keep your threads private and well-organized. diff --git a/docs/docs/hardware/overview/cloud-vs-self-hosting.md b/docs/docs/hardware/overview/cloud-vs-self-hosting.md index 0d34bb1a9..8a24ed5af 100644 --- a/docs/docs/hardware/overview/cloud-vs-self-hosting.md +++ b/docs/docs/hardware/overview/cloud-vs-self-hosting.md @@ -2,6 +2,18 @@ title: Cloud vs. Self-hosting Your AI --- + + Cloud vs. Self-hosting Your AI + + + + + + + + + + The choice of how to run your AI - on GPU cloud services, on-prem, or just using an API provider - involves various trade-offs. The following is a naive exploration of the pros and cons of renting vs self-hosting. ## Cost Comparison diff --git a/docs/docs/hardware/overview/cpu-vs-gpu.md b/docs/docs/hardware/overview/cpu-vs-gpu.md index f0f20d8d6..e22dc43dc 100644 --- a/docs/docs/hardware/overview/cpu-vs-gpu.md +++ b/docs/docs/hardware/overview/cpu-vs-gpu.md @@ -2,6 +2,20 @@ title: GPU vs CPU What's the Difference? --- + + GPU vs CPU What's the Difference? + + + + + + + + + + + + ## CPU vs. GPU | | CPU | GPU | diff --git a/docs/docs/how-we-work.md b/docs/docs/how-we-work.md index e81099d18..20f3fb685 100644 --- a/docs/docs/how-we-work.md +++ b/docs/docs/how-we-work.md @@ -2,6 +2,18 @@ title: How We Work --- + + How We Work - Jan + + + + + + + + + + ### Open Source Jan is a startup with an open source business model. We believe in the need for an open source AI ecosystem, and are committed to building it. diff --git a/docs/docs/how-we-work/analytics/analytics.md b/docs/docs/how-we-work/analytics/analytics.md index 79e107a83..a2333a13a 100644 --- a/docs/docs/how-we-work/analytics/analytics.md +++ b/docs/docs/how-we-work/analytics/analytics.md @@ -2,6 +2,18 @@ title: Analytics --- + + Analytics + + + + + + + + + + Adhering to Jan's privacy preserving philosophy, our analytics philosophy is to get "barely-enough-to-function'. #### What is tracked diff --git a/docs/docs/how-we-work/engineering/qa.mdx b/docs/docs/how-we-work/engineering/qa.mdx index f43caae4a..43abdc12a 100644 --- a/docs/docs/how-we-work/engineering/qa.mdx +++ b/docs/docs/how-we-work/engineering/qa.mdx @@ -15,6 +15,18 @@ keywords: ] --- + + QA + + + + + + + + + + ### Phase 1: Planning #### Definition of Ready (DoR): diff --git a/docs/docs/how-we-work/project-management/project-management.md b/docs/docs/how-we-work/project-management/project-management.md index 58af4a0d3..d7429b66e 100644 --- a/docs/docs/how-we-work/project-management/project-management.md +++ b/docs/docs/how-we-work/project-management/project-management.md @@ -2,6 +2,18 @@ title: Project Management --- + + Project Management + + + + + + + + + + We use the [Jan Monorepo Project](https://github.com/orgs/janhq/projects/5) in Github to manage our roadmap and sprint Kanbans. As much as possible, everyone owns their respective `epics` and `tasks`. @@ -58,7 +70,6 @@ We aim to always sprint on `tasks` that are a part of the [current roadmap](http - `Urgent bugs`: assign to an owner (or @engineers if you are not sure) && tag the current `sprint` & `milestone` - `All else`: assign the correct roadmap `label(s)` and owner (if any) - #### Request for help As a result, our feature prioritization can feel a bit black box at times. diff --git a/docs/docs/how-we-work/strategy/strategy.md b/docs/docs/how-we-work/strategy/strategy.md index 09d9b9fb4..c0dc5c44c 100644 --- a/docs/docs/how-we-work/strategy/strategy.md +++ b/docs/docs/how-we-work/strategy/strategy.md @@ -2,7 +2,20 @@ title: Strategy --- + + Strategy + + + + + + + + + + We only have 2 planning parameters: + - 10 year vision - 2 week sprint - Quarterly OKRs @@ -46,7 +59,6 @@ Jan is a seamless user experience that runs on your personal computer, that glue - We run on top of a local folder of non-proprietary files, that anyone can tinker with (yes, even other apps!) - We provide open formats for packaging and distributing AI to run reproducibly across devices - ## Prerequisites - [Figma](https://figma.com) diff --git a/docs/docs/how-we-work/website-docs/website-docs.md b/docs/docs/how-we-work/website-docs/website-docs.md index 19fdc1676..f2ec98e9a 100644 --- a/docs/docs/how-we-work/website-docs/website-docs.md +++ b/docs/docs/how-we-work/website-docs/website-docs.md @@ -2,6 +2,18 @@ title: Website & Docs --- + + Website & Docs + + + + + + + + + + This website is built using [Docusaurus 3.0](https://docusaurus.io/), a modern static website generator. ### Information Architecture diff --git a/docs/docs/platforms/desktop.md b/docs/docs/platforms/desktop.md index fb4ea8389..d2b0efce5 100644 --- a/docs/docs/platforms/desktop.md +++ b/docs/docs/platforms/desktop.md @@ -15,6 +15,18 @@ keywords: ] --- + + Jan Desktop + + + + + + + + + + # Turn any computer into an AI computer ![Alt text](image.png) diff --git a/docs/docs/server-suite/enterprise.md b/docs/docs/server-suite/enterprise.md index 565c14fde..1823bfddd 100644 --- a/docs/docs/server-suite/enterprise.md +++ b/docs/docs/server-suite/enterprise.md @@ -15,6 +15,18 @@ keywords: ] --- + + Jan Enterprise + + + + + + + + + + # Customize and run AI across your organization Jan can professional backend to create, customize and run AIs at scale, for production-grade data centers. diff --git a/docs/docs/server-suite/home-server.md b/docs/docs/server-suite/home-server.md index 97f3afbc7..9e766564c 100644 --- a/docs/docs/server-suite/home-server.md +++ b/docs/docs/server-suite/home-server.md @@ -15,6 +15,18 @@ keywords: ] --- + + Jan Home Server + + + + + + + + + + # Customize and run AI across all of your devices Self-host and access your AI from anywhere with Jan server suite. diff --git a/docs/docs/team/team.md b/docs/docs/team/team.md index 7d5e07cfb..e6ef906f1 100644 --- a/docs/docs/team/team.md +++ b/docs/docs/team/team.md @@ -2,6 +2,18 @@ title: Who we are --- + + Who we are - Jan + + + + + + + + + + What's Jan the company about? We aim to build the cognitive framework for future robots @@ -13,7 +25,6 @@ Jan is a startup with an open source business model. We believe in the need for - [Jan Desktop Client & Local server](https://jan.ai) (AGPLv3, built on Jan Framework) - [Nitro: run Local AI](https://github.com/janhq/nitro) (AGPLv3) - ### Bootstrapped Jan is currently a bootstrapped startup. @@ -25,4 +36,4 @@ We balance technical invention with the search for a sustainable business model. ## Our Team - Contributors -- Core Team \ No newline at end of file +- Core Team diff --git a/docs/docs/wall-of-love.md b/docs/docs/wall-of-love.md index f6bfe79d8..7d130f373 100644 --- a/docs/docs/wall-of-love.md +++ b/docs/docs/wall-of-love.md @@ -2,6 +2,18 @@ title: Wall of Love ❤️ --- + + Wall of Love ❤️ - Jan + + + + + + + + + + ## Twitter Check out our amazing users and what they are saying about Jan!