text stringlengths 56 11.6k | source stringlengths 10 64 |
|---|---|
# How We Work
### 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.
- [Jan Framework](https://github.com/janhq/jan) (AGPLv3)
- [Jan Desktop Client & Local server](https://jan.ai) (AGPLv3, built on Jan Framework)
-... | https://jan.ai/how-we-work |
# Wall of Love ❤️
## Twitter
Check out our amazing users and what they are saying about Jan!
<div>
<blockquote class="twitter-tweet"><p lang="en" dir="ltr">I can confirm <a href="https://t.co/Hvrfp0iaf9">https://t.co/Hvrfp0iaf9</a> is awesome 👌</p>— Cristian (@cristianmoreno) <a href="https://twitter.com/crist... | https://jan.ai/wall-of-love |
# Acknowledgements
# Acknowledgements
We would like to express our gratitude to the following third-party libraries that have made the development of Jan possible.
- [llama.cpp](https://github.com/ggerganov/llama.cpp/blob/master/LICENSE)
- [LangChain.js](https://github.com/langchain-ai/langchainjs/blob/main/LICENSE)
... | https://jan.ai/acknowledgements |
# Hardware Examples
## Add your own example
Add your own examples to this page by creating a new file in the `docs/docs/hardware/examples` directory.
```shell
docs
└── docs
└── hardware
└── examples
└── 3090x1-%40dan-jan.md
└── 3090x1-%40dan-jan.md
// highlight-next-li... | https://jan.ai/hardware/community |
# Motherboard
- PCIe lanes that go to the processor (not Chipset) | https://jan.ai/hardware/concepts/motherboard |
# Anatomy of a Thinking Machine
- Cover the difference between CPU/RAM and GPU/VRAM
- AI can now run on CPU/RAM (llama.cpp)
- AI that runs on Apple Silicon | https://jan.ai/hardware/concepts |
# GPUs and VRAM
## What Is a GPU?
A Graphics Card, or GPU (Graphics Processing Unit), is a fundamental component in modern computing. Think of it as the powerhouse behind rendering the stunning visuals you see on your screen. Similar to the motherboard in your computer, the graphics card is a printed circuit board. Ho... | https://jan.ai/hardware/concepts/gpu-and-vram |
# CPU
- CPU's role vs GPU
- Cooler + Thermal Paste
- RAM | https://jan.ai/hardware/concepts/cpu-and-ram |
# "2 x 4090 Workstation"
Jan uses a 2 x 4090 Workstation to run Codellama for internal use.[^1]
## Component List
| Type | Item | Unit Price | Total Price |
| : | https://jan.ai/hardware/examples/4090x2-@dan-jan |
# Recommended AI Hardware by Model
## Codellama 34b
### System Requirements:
**For example**: If you want to use [Codellama 7B](https://huggingface.co/TheBloke/CodeLlama-7B-Instruct-GPTQ/tree/main) models on your own computer, you can take advantage of your GPU and run this with GPTQ file models.
GPTQ is a format th... | https://jan.ai/hardware/recommendations/by-model |
# Selecting AI Hardware
When selecting a GPU for LLMs, remember that it's not just about the GPU itself. Consider the synergy with other components in your PC:
- **CPU**: To ensure efficient processing, pair your GPU with a powerful CPU. LLMs benefit from fast processors, so having a capable CPU is essential.
- **RAM*... | https://jan.ai/hardware/recommendations/by-hardware |
# Recommended AI Hardware by Use Case
## Which AI Hardware to Choose Based on Your Use Case
Artificial intelligence (AI) is rapidly changing the world, and AI hardware is becoming increasingly important for businesses and individuals alike. Choosing the right hardware for your AI needs is crucial to get the best perfo... | https://jan.ai/hardware/recommendations/by-usecase |
# Recommended AI Hardware by Budget
> :warning: **Warning:** Do your own research before any purchase. Jan is not liable for compatibility, performance or other issues. Products can become outdated quickly.
## Entry-level PC Build at $1000
| Type | Item ... | https://jan.ai/hardware/recommendations/by-budget |
# GPU vs CPU What's the Difference?
## CPU vs. GPU
| | CPU | GPU |
| | https://jan.ai/hardware/overview/cpu-vs-gpu |
# 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
The following estimations use these general assumpti... | https://jan.ai/hardware/overview/cloud-vs-self-hosting |
# Who we are
What's Jan the company about?
We aim to build the cognitive framework for future robots
### 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.
- [Jan Framework](https://github.com/janhq/jan) (AGPLv3)
... | https://jan.ai/team/team |
# Join us
- [ ] Explain Core Team, Contributors and Open Source approach
[Careers on Bamboo](https://janai.bamboohr.com/careers)
### Careers
Jan has a culture of ownership, independent thought, and lightning fast execution. If you'd like to join us, we have open positions on our [careers page](https://janai.bambooh... | https://jan.ai/team/join-us |
# Regression test
**Release Version:** v0.4.7
**Operating System:** MacOS
---
## A. Installation, Update, and Uninstallation
### 1. Users install app
- [ ] Check that the installation package is not corrupted and passes all security checks.
- [ ] :key: Confirm that the app launches successfully after installation... | QA_script.md |
# 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.
:::warning
The server suite is actively under development and lacking documentation.
You can find the source code [here](https://github.com/janhq... | https://jan.ai/enterprise |
# Jan Home Server
# Customize and run AI across all of your devices
Self-host and access your AI from anywhere with Jan server suite.
:::warning
Jan's server suite is actively under development and lacking documentation.
You can find the source code [here](https://github.com/janhq/jan/tree/dev/server) and [here](htt... | https://jan.ai/home-server |
# Pre-configured Models
## Overview
Jan provides various pre-configured AI models with different capabilities. Please see the following list for details.
| Model | Description |
| | https://jan.ai/guides/models-list |
# Quickstart
import installImageURL from './assets/jan-ai-quickstart.png';
import flow from './assets/quick.png';
# Quickstart
{/* After finish installing, here are steps for using Jan
## Run Jan
<Tabs>
<TabItem value="mac" label="MacOS" default>
1. Search Jan in the Dock and run the program.
</TabI... | https://jan.ai/guides |
# Best Practices
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 ... | https://jan.ai/guides/best-practices |
# Installation
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import installImageURL from './assets/jan-ai-download.png';
<Tabs>
<TabItem value="mac" label = "Mac" default>
### Pre-requisites
Ensure that your MacOS version is 13 or higher to run Jan.
### Stable Rele... | https://jan.ai/guides/install |
# Local Server
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.
## Step 1: Set the Local Server
To start the local server, follow the steps below:
1. Nav... | https://jan.ai/guides/start-server |
# Thread Management
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
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 r... | https://jan.ai/guides/thread |
# 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
### 1. Create a Model JSON
1. In `~/jan/models`, create a folder named `gpt-3.5-turbo-16k`.
2. In this folder, add a `model.json` file w... | https://jan.ai/guides/models/integrate-remote |
# Manual Import
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import janModel from './assets/jan-model-hub.png';
This guide will show you how to perform manual import. In this guide, we are using a GGUF model from [HuggingFace](https://huggingface.co/) and our latest model, [Trinity](https://h... | https://jan.ai/guides/models/import-models |
# Customize Engine Settings
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
In this guide, we'll walk you through the process of customizing your engine settings by configuring the `nitro.json` file
1. Navigate to the `App Settings` > `Advanced` > `Open App Directory` > `~/jan/engine` folder.
... | https://jan.ai/guides/models/customize-engine |
# Import Extensions
Besides default extensions, you can import extensions into Jan by following the steps below:
1. Navigate to **Settings** > **Extensions** > Click Select under **Manual Installation**.
2. Then, the ~/jan/extensions/extensions.json file will be updated automatically.
:::caution
You need to prepare... | https://jan.ai/guides/extensions/import-ext |
# Extension Setup
The current Jan Desktop Client has some default extensions built on top of this framework to enhance the user experience. In this guide, we will show you the list of default extensions and how to configure extension settings.
## Default Extensions
You can find the default extensions in the `Settings... | https://jan.ai/guides/extensions/setup-ext |
# HTTPS Proxy
## Why HTTPS Proxy?
HTTPS Proxy encrypts data between your browser and the internet, making it hard for outsiders to intercept or read. It also helps you to maintain your privacy and security while being able to bypass regional restrictions on internet.
:::note
When configuring Jan using an HTTPS proxy... | https://jan.ai/guides/advanced-settings/http-proxy |
# Advanced Settings
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
This guide will show you how to use the advanced settings in Jan.
## Access the Advanced Settings
To access the Jan's advanced settings, follow the steps below:
1. Navigate to the main dashboard.
2. Click the **gear icon (⚙️)** ... | https://jan.ai/guides/advanced-settings/advanced-settings |
# 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
2. Manually run the nitro tool located at... | https://jan.ai/guides/error-codes/undefined-issue |
# Permission Denied
When running Jan, you might encounter the following error message:
```
Uncaught (in promise) Error: Error invoking layout-480796bff433a3a3.js:538 remote method 'installExtension':
Error Package /Applications/Jan.app/Contents/Resources/app.asar.unpacked/pre-install/janhq-assistant-extension-1.0.0.tg... | https://jan.ai/guides/error-codes/permission-denied |
# 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.open... | https://jan.ai/guides/error-codes/unexpected-token |
# Something's Amiss
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
When you start a chat with a model and encounter with a Something's Amiss error, here's how to resolve it:
1. Ensure your OS is up to date.
2. Choose a model smaller than 80% of your hardware's V/RAM. For example, on an 8GB mach... | https://jan.ai/guides/error-codes/something-amiss |
# v0.3.0
For more details, [GitHub Issues](https://github.com/janhq/jan/releases/tag/v0.3.0)
Highlighted Issue: [Issue #482: fix: hide preferences section if empty](https://github.com/janhq/jan/pull/482)
## Changes
- fix: hide preferences section if empty @louis-jan (#482)
- chore: fix conversation summary @louis-... | https://jan.ai/guides/changelog/changelog-v0.3.0 |
# v0.4.0
For more details, [GitHub Issues](https://github.com/janhq/jan/releases/tag/v0.4.0)
Highlighted Issue: [Issue #878: bug: fix tag description showing a title and fix card right panel](https://github.com/janhq/jan/pull/878)
## Changes
- bug: fix tag description showing a title and fix card right panel @urma... | https://jan.ai/guides/changelog/changelog-v0.4.0 |
# v0.2.1
For more details, [GitHub Issues](https://github.com/janhq/jan/releases/tag/v0.2.1)
Highlighted Issue: [Issue #446: fix: model is started but the indicator is not stopped loading](https://github.com/janhq/jan/pull/446)
## Changes
- fix: model is started but the indicator is not stopped loading @louis-jan ... | https://jan.ai/guides/changelog/changelog-v0.2.1 |
# v0.4.6
For more details, [GitHub Issues](https://github.com/janhq/jan/releases/tag/v0.4.6)
Highlighted Issue: [Issue #1918: Regression fix assistant extension codesign](https://github.com/janhq/jan/pull/1918)
## Changes
- Regression fix assitant extension codesign @hiento09 (#1918)
- Release cut 0.4.6 @louis-jan... | https://jan.ai/guides/changelog/changelog-v0.4.6 |
# v0.2.0
For more details, [GitHub Issues](https://github.com/janhq/jan/releases/tag/v0.2.0)
Highlighted Issue: [Issue #342: feat: Add Jan Hacker House event page to Docs](https://github.com/janhq/jan/pull/342)
## Changes
- feat: Add Jan Hacker House event page to Docs @dan-jan (#342)
- feat: Hide incomplete Hardw... | https://jan.ai/guides/changelog/changelog-v0.2.0 |
# v0.2.3
For more details, [GitHub Issues](https://github.com/janhq/jan/releases/tag/v0.2.3)
Highlighted Issue: [Issue #482: fix: hide preferences section if empty](https://github.com/janhq/jan/pull/482)
## Changes
- fix: hide preferences section if empty @louis-jan (#482)
- chore: fix conversation summary @louis-... | https://jan.ai/guides/changelog/changelog-v0.2.3 |
# v0.4.5
For more details, [GitHub Issues](https://github.com/janhq/jan/releases/tag/v0.4.5)
Highlighted Issue: [Issue #1758: bug: Correct text for Windows](https://github.com/janhq/jan/issues/1758)
## Changes
- fix(Wording): #1758 correct text for windows @namchuai (#1768)
- fix(Log): server log is not display in... | https://jan.ai/guides/changelog/changelog-v0.4.5 |
# v0.2.2
For more details, [GitHub Issues](https://github.com/janhq/jan/releases/tag/v0.2.2)
Highlighted Issue: [Issue #469: chore: plugin and app version dependency](https://github.com/janhq/jan/pull/469)
## Changes
- chore: plugin and app version dependency @louis-jan (#469)
- bug: showing a modal when user star... | https://jan.ai/guides/changelog/changelog-v0.2.2 |
# v0.4.1
For more details, [GitHub Issues](https://github.com/janhq/jan/releases/tag/v0.4.1)
Highlighted Issue: [Issue #903: Update README.md](https://github.com/janhq/jan/pull/903)
## Changes
- Update README.md @imtuyethan (#903)
## 🚀 Features
- feat: Kill nitro process with API - nitro 0.1.27 @vuonghoainam (#... | https://jan.ai/guides/changelog/changelog-v0.4.1 |
# v0.3.1
For more details, [GitHub Issues](https://github.com/janhq/jan/releases/tag/v0.3.1)
Highlighted Issue: [Issue #580: fix: preformatted text indents the first line strangely](https://github.com/janhq/jan/pull/580)
## Changes
- fix: preformatted text indents the first line strangely @louis-jan (#580)
- fix: ... | https://jan.ai/guides/changelog/changelog-v0.3.1 |
# v0.3.3
For more details, [GitHub Issues](https://github.com/janhq/jan/releases/tag/v0.3.3)
Highlighted Issue: [Issue #719: docs: cleanup](https://github.com/janhq/jan/pull/719)
## Changes
- docs: cleanup @0xSage (#719)
- docs: threads and messages @0xSage (#681)
- Updating Onboarding Kit @Diane0111 (#675)
- Upda... | https://jan.ai/guides/changelog/changelog-v0.3.3 |
# v0.3.2
For more details, [GitHub Issues](https://github.com/janhq/jan/releases/tag/v0.3.2)
Highlighted Issue: [Issue #612: fix: disabled required env](https://github.com/janhq/jan/pull/612)
## Changes
- fix: disabled required env @urmauur (#612)
- Install Posthog snippet @imtuyethan (#573)
- web: google tag mana... | https://jan.ai/guides/changelog/changelog-v0.3.2 |
# v0.4.3
For more details, [GitHub Issues](https://github.com/janhq/jan/releases/tag/v0.4.3)
Highlighted Issue: [Issue #1159: Hotfix Prompt template for models on the Hub](https://github.com/janhq/jan/pull/1159)
## Changes
- Hotfix Prompt template for models on the Hub @hahuyhoang411 (#1159)
- Update model list fo... | https://jan.ai/guides/changelog/changelog-v0.4.3 |
# v0.4.4
For more details, [GitHub Issues](https://github.com/janhq/jan/releases/tag/v0.4.4)
Highlighted Issue: [Issue #1587: Update 2023-11-05-hello-world.md](https://github.com/janhq/jan/pull/1587)
## Changes
- Update 2023-11-05-hello-world.md @Ssstars (#1587)
- fix(API): #1511 update swagger page @namchuai (#15... | https://jan.ai/guides/changelog/changelog-v0.4.4 |
# v0.4.2
For more details, [GitHub Issues](https://github.com/janhq/jan/releases/tag/v0.4.2)
Highlighted Issue: [Issue #1033: Hotfix model hub](https://github.com/janhq/jan/pull/1033)
## Changes
- Hotfix model hub @hahuyhoang411 (#1033)
- Update Model.json @hahuyhoang411 (#1005)
## 🚀 Features
- feat: app theme ... | https://jan.ai/guides/changelog/changelog-v0.4.2 |
# v0.4.7
For more details, [GitHub Issues](https://github.com/janhq/jan/releases/tag/v0.4.7)
Highlighted Issue: [Issue #2121: Release cut v0.4.7](https://github.com/janhq/jan/pull/2121)
## Changes
- Release cut v0.4.7 @louis-jan (#2121)
- chore: update models @hahuyhoang411 (#1829)
- add docs for entire advanced s... | https://jan.ai/guides/changelog/changelog-v0.4.7 |
# Troubleshooting NVIDIA GPU
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
This guide provides steps to troubleshoot and resolve issues when the Jan app does not utilize the NVIDIA GPU on Windows and Linux systems.
### 1. Ensure GPU Mode Requirements
<Tabs>
<TabItem value="windows" label="... | https://jan.ai/guides/common-error/not-using-gpu |
# Broken Build
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
This guide provides you steps to troubleshoot and to resolve the issue where your Jan is stuck in a broken build after installation.
<Tabs>
<TabItem value="mac" label="Mac" default>
### 1. Uninstall Jan
Delete Ja... | https://jan.ai/guides/common-error/broken-build |
# 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):
1. API
2. Open-source models on Hugging Face.
To integrate Jan with Mistral AI, follow the steps below:
:::note
This tutorial demonstrates integrating Mistral AI w... | https://jan.ai/guides/integration/mistral |
# 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:
### Step 1: Do... | https://jan.ai/guides/integration/raycast |
# 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:
1. Integrate Ollama server with Jan.
2. Migrate the downloaded model from Ollama to Jan.
To integrate Ollama with Jan, follow the steps below:
:::note
In... | https://jan.ai/guides/integration/ollama |
# 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 fo... | https://jan.ai/guides/integration/azure |
# 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.
To integrate Jan with a Discord bot, follow the steps below:
### Step 1: Clone the reposito... | https://jan.ai/guides/integration/discord |
# 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:
1. Integrate the LM Studio server with Jan UI
2. Migrate your downloaded model from LM Studio to Jan... | https://jan.ai/guides/integration/lmstudio |
# Open Interpreter
## How to Integrate Open Interpreter with Jan
[Open Interpreter](https://github.com/KillianLucas/open-interpreter/) lets LLMs run code (Python, Javascript, Shell, and more) locally. You can chat with Open Interpreter through a ChatGPT-like interface in your terminal by running `interpreter` after in... | https://jan.ai/guides/integration/openinterpreter |
# OpenRouter
## How to Integrate OpenRouter with Jan
[OpenRouter](https://openrouter.ai/docs#quick-start) is a tool that gathers AI models. Developers can utilize its API to engage with diverse large language models, generative image models, and generative 3D object models.
To connect Jan with OpenRouter for accessin... | https://jan.ai/guides/integration/openrouter |
# Continue
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## How to Integrate with Continue VS Code
[Continue](https://continue.dev/docs/intro) is an open-source autopilot compatible with Visual Studio Code and JetBrains, offering the simplest method to code with any LLM (Local Language Model).... | https://jan.ai/guides/integration/vscode |
# llama.cpp
## Quicklinks
- Jan Framework [Extension Code](https://github.com/janhq/jan/tree/main/extensions/inference-nitro-extension)
- ggerganov/llama.pp [Source URL](https://github.com/ggerganov/llama.cpp)
- [Productized Wrapper](https://nitro.jan.ai/): a bit lower effort to use out of the box | https://jan.ai/integrations/llamacpp |
# TensorRT-LLM
## Quicklinks
- Jan Framework [Extension Code](https://github.com/janhq/jan/tree/main/extensions/inference-triton-trtllm-extension)
- TensorRT [Source URL](https://github.com/NVIDIA/TensorRT-LLM) | https://jan.ai/integrations/tensorrt |
# OpenAI
## Quicklinks
- Jan Framework [Extension Code](https://github.com/janhq/jan/tree/main/extensions/inference-openai-extension)
- OpenAI API [Reference Docs](https://platform.openai.com/docs/api-reference) | https://jan.ai/integrations/openai |
# Jan's Community
## Socials
- [Discord](https://discord.gg/SH3DGmUs6b)
- [X](https://twitter.com/janframework)
- [HuggingFace](https://huggingface.co/janhq)
- [LinkedIn](https://www.linkedin.com/company/janframework/)
## Community Run
- [Reddit](https://www.reddit.com/r/janframework/)
## Careers
- [Jobs](https://... | https://jan.ai/community |
# "Nov 23: Nvidia GenAI Day"
## Nvidia GenAI Innovation Day
Jan will be at Nvidia's GenAI Innovation Day in Nov '23, focusing on Enterprise use-cases of LLMs.
### Location
- JW Marriott Hanoi Hotel
- 8:30am November 8th 2023
- Registration: [https://gmcgroup.com.vn/nvidia-genai... | https://jan.ai/events/nvidia-llm-day-nov-23 |
# "Jan's AI Hacker House (Ho Chi Minh City)"
🎉 Join us at our Friday Launch Party for an evening of AI talks from other builders! [(RSVP here)](https://jan-launch-party.eventbrite.sg/) 🎉
## Ho Chi Minh City
[Jan's Hacker House](https://jan.ai) is a 4-day event where we host an open ... | https://jan.ai/events/hcmc-oct23 |
# About Jan
Jan is a [open-source](https://en.wikipedia.org/wiki/Open_source), [local-first](https://www.inkandswitch.com/local-first/) tool to [create, customize and use AI](https://www.gatesnotes.com/AI-agents) for everyday tasks.
You can:
- Run locally using [open-source LLMs](https://huggingface.co/models?pipelin... | https://jan.ai/about |
# Roadmap
- [ ] [Immediate Roadmap on Github](https://github.com/orgs/janhq/projects/5/views/16)
- [ ] [Longer-term Roadmap on Discord](https://discord.gg/Ey62mynnYr) | https://jan.ai/about/roadmap |
# Jan's Vision for 2035
[Jan 2035: A Robotics Company](https://hackmd.io/QIWyYbNNQVWVbupuI3kjAA)
We only have 2 planning parameters:
- 10 year vision
- 2 week sprint
And we measure our success on Quarterly OKRs | https://jan.ai/about/2035 |
# Pricing
| $0 | $1 | Enterprise |
| | https://jan.ai/pricing |
# Support
- Bugs & requests: file a GitHub ticket [here](https://github.com/janhq/jan/issues)
- For discussion: join our Discord [here](https://discord.gg/FTk2MvZwJH)
- For business inquiries: email hello@jan.ai
- For jobs: please email hr@jan.ai
| support.md |
# Privacy Policy
Jan is committed to protecting your privacy and ensuring that your personal information is handled in a safe and responsible way. This policy outlines how we collect, store, and use your personal information when you use our mobile application.
## Data Collection and Usage
When you use Jan, we may c... | privacy.md |
# Architecture
:::warning
This page is still under construction, and should be read as a scratchpad
:::
## Overview
- Jan has a modular architecture and is largely built on top of its own modules.
- Jan uses a local [file-based approach](/developer/file-based) for data persistence.
- Jan provides an Electron-based ... | https://jan.ai/developer/architecture |
# User Interface
:::warning
This page is still under construction, and should be read as a scratchpad
:::
Jan provides a UI Kit for customize the UI for your use case. This means you can personalize the entire application according to your own brand and visual styles.
This page gives you an overview of how to custo... | https://jan.ai/developer/ui |
# Installation and Prerequisites
## Requirements
### Hardware Requirements
Ensure your system meets the following specifications to guarantee a smooth development experience:
- Hardware Requirements
### System Requirements
Make sure your operating system meets the specific requirements for Jan development:
- [Win... | https://jan.ai/developer/prereq |
# File-based Approach
:::warning
This page is still under construction, and should be read as a scratchpad
:::
Jan use the local filesystem for data persistence, similar to VSCode. This allows for composability and tinkerability.
```yaml
janroot/ # Jan's root folder (e.g. ~/jan)
models/ ... | https://jan.ai/developer/file-based |
# Overview
The following docs are aimed at developers who want to build extensions on top of the Jan Framework.
:::tip
If you are interested to **contribute to the framework's Core SDK itself**, like adding new drivers, runtimes, and infrastructure level support, please refer to [framework docs](/developer/framework) ... | https://jan.ai/developer |
# Your First Extension
:::caution
This is currently under development.
:::
In this guide, we'll walk you through the process of building your first extension and integrating it into Jan.
## Steps to Create Your First Extension
To create your own extension, you can follow the steps below:
1. Click the **Use this tem... | https://jan.ai/developer/build-extension/your-first-extension/ |
# Your First Engine
:::caution
This is currently under development.
:::
A quickstart on how to integrate tensorrt llm | https://jan.ai/developer/build-engine/your-first-engine/ |
# Framework
The following low-level docs are aimed at core contributors.
We cover how to contribute to the core framework (aka the `Core SDK`).
:::tip
If you are interested to **build on top of the framework**, like creating assistants or adding app level extensions, please refer to [developer docs](/developer) inste... | https://jan.ai/developer/framework/ |
# Chats
:::caution
This is currently under development.
:::
## Overview
In Jan, `chats` are LLM responses in the form of OpenAI compatible `chat completion objects`.
- Models take a list of messages and return a model-generated response as output.
- An [OpenAI Chat API](https://platform.openai.com/docs/api-referen... | https://jan.ai/developer/framework/engineering/chats |
# Engine
:::caution
Currently Under Development
:::
## Overview
In the Jan application, engines serve as primary entities with the following capabilities:
- Engine will be installed through `inference-extensions`.
- Models will depend on engines to do [inference](https://en.wikipedia.org/wiki/Inference_engine).
- ... | https://jan.ai/developer/framework/engineering/engine |
# Engineering Specs
import DocCardList from "@theme/DocCardList";
<DocCardList className="DocCardList--no-description" />
Talk about CoreSDK here | https://jan.ai/developer/engineering |
# Prompts
- [ ] /prompts folder
- [ ] How to add to prompts
- [ ] Assistants can have suggested Prompts | https://jan.ai/developer/framework/engineering/prompts |
# Threads
:::caution
This is currently under development.
:::
## Overview
`Threads` are conversations between an `assistant` and the user:
- Users can tweak `model` params and `assistant` behavior within each thread.
- Users can import and export threads.
- An [OpenAI Thread API](https://platform.openai.com/docs/a... | https://jan.ai/developer/framework/engineering/threads |
# "Files"
:::warning
Draft Specification: functionality has not been implemented yet.
:::
Files can be used by `threads`, `assistants` and `fine-tuning`
> Equivalent to: https://platform.openai.com/docs/api-reference/files
## Files Object
- Equivalent to: https://platform.openai.com/docs/api-reference/files
- Not... | https://jan.ai/developer/framework/engineering/files |
# "Assistants"
:::caution
This is currently under development.
:::
## Overview
In Jan, assistants are `primary` entities with the following capabilities:
- Assistants can use `models`, `tools`, handle and emit `events`, and invoke `custom code`.
- Users can create custom assistants with saved `model` settings and ... | https://jan.ai/developer/framework/engineering/assistants |
# Models
:::caution
This is currently under development.
:::
## Overview
In Jan, models are primary entities with the following capabilities:
- Users can import, configure, and run models locally.
- An [OpenAI Model API](https://platform.openai.com/docs/api-reference/models) compatible endpoint at `localhost:1337/... | https://jan.ai/developer/framework/engineering/models |
# Messages
:::caution
This is currently under development.
:::
## Overview
`Messages` capture a conversation's content. This can include the content from LLM responses and other metadata from [chat completions](/specs/chats).
- Users and assistants can send multimedia messages.
- An [OpenAI Message API](https://pl... | https://jan.ai/developer/framework/engineering/messages |
# 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
- Your... | https://jan.ai/developer/framework/product/jan |
# Product Specs
import DocCardList from "@theme/DocCardList";
<DocCardList className="DocCardList--no-description" /> | https://jan.ai/developer/product |
# Chat
## Overview
A home screen for users to chat with [assistants](/docs/engineering/assistants) via conversation [threads](/docs/engineering/threads).
## User Stories
<!-- Can also be used as a QA Checklist -->
- Users can chat with `Jan` the default assistant
- Users can cus... | https://jan.ai/developer/framework/product/chat |
# System Monitor
## Overview
An activity screen to monitor system health and running models.
## User Stories
<!-- Can also be used as a QA Checklist -->
- Users can see disk and ram utilization
- Users can start and stop models based on system health | https://jan.ai/developer/framework/product/system-monitor |
# Hub
## Overview
The Hub is like a store for everything, where users can discover and download models, assistants, and more.
## User Stories
<!-- Can also be used as a QA Checklist -->
- Users can discover recommended models (Jan ships with a few preconfigured `model.json` files... | https://jan.ai/developer/framework/product/hub |
# 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.
## User Stories
<!-- Can also be used as a QA Checklist -->
### General Settings
- Users ca... | https://jan.ai/developer/framework/product/settings |
# Analytics
Adhering to Jan's privacy preserving philosophy, our analytics philosophy is to get "barely-enough-to-function'.
#### What is tracked
1. By default, Github tracks downloads and device metadata for all public GitHub repositories. This helps us troubleshoot & ensure cross-platform support.
2. We use [Umami]... | https://jan.ai/how-we-work/analytics/analytics |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.