Nicholai/jan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'dev' into feat/revamp-website

Browse Source
This commit is contained in:
Henry 2024-03-19 14:47:11 +09:00 committed by GitHub
commit 4be979cedb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
129 changed files with 2385 additions and 203 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.github/workflows/jan-electron-linter-and-test.yml vendored
View File

@ -22,6 +22,7 @@ on:
branches:
- main
- dev
- release/**
paths:
- "electron/**"
- .github/workflows/jan-electron-linter-and-test.yml

21
README.md
View File

@ -43,31 +43,31 @@ Jan is an open-source ChatGPT alternative that runs 100% offline on your compute
<tr style="text-align:center">
<td style="text-align:center"><b>Stable (Recommended)</b></td>
<td style="text-align:center">
<a href='https://github.com/janhq/jan/releases/download/v0.4.8/jan-win-x64-0.4.8.exe'>
<a href='https://github.com/janhq/jan/releases/download/v0.4.9/jan-win-x64-0.4.9.exe'>
<img src='./docs/static/img/windows.png' style="height:14px; width: 14px" />
<b>jan.exe</b>
</a>
</td>
<td style="text-align:center">
<a href='https://github.com/janhq/jan/releases/download/v0.4.8/jan-mac-x64-0.4.8.dmg'>
<a href='https://github.com/janhq/jan/releases/download/v0.4.9/jan-mac-x64-0.4.9.dmg'>
<img src='./docs/static/img/mac.png' style="height:15px; width: 15px" />
<b>Intel</b>
</a>
</td>
<td style="text-align:center">
<a href='https://github.com/janhq/jan/releases/download/v0.4.8/jan-mac-arm64-0.4.8.dmg'>
<a href='https://github.com/janhq/jan/releases/download/v0.4.9/jan-mac-arm64-0.4.9.dmg'>
<img src='./docs/static/img/mac.png' style="height:15px; width: 15px" />
<b>M1/M2</b>
</a>
</td>
<td style="text-align:center">
<a href='https://github.com/janhq/jan/releases/download/v0.4.8/jan-linux-amd64-0.4.8.deb'>
<a href='https://github.com/janhq/jan/releases/download/v0.4.9/jan-linux-amd64-0.4.9.deb'>
<img src='./docs/static/img/linux.png' style="height:14px; width: 14px" />
<b>jan.deb</b>
</a>
</td>
<td style="text-align:center">
<a href='https://github.com/janhq/jan/releases/download/v0.4.8/jan-linux-x86_64-0.4.8.AppImage'>
<a href='https://github.com/janhq/jan/releases/download/v0.4.9/jan-linux-x86_64-0.4.9.AppImage'>
<img src='./docs/static/img/linux.png' style="height:14px; width: 14px" />
<b>jan.AppImage</b>
</a>
@ -76,31 +76,31 @@ Jan is an open-source ChatGPT alternative that runs 100% offline on your compute
<tr style="text-align:center">
<td style="text-align:center"><b>Experimental (Nightly Build)</b></td>
<td style="text-align:center">
<a href='https://delta.jan.ai/latest/jan-win-x64-0.4.8-325.exe'>
<a href='https://delta.jan.ai/latest/jan-win-x64-0.4.9-334.exe'>
<img src='./docs/static/img/windows.png' style="height:14px; width: 14px" />
<b>jan.exe</b>
</a>
</td>
<td style="text-align:center">
<a href='https://delta.jan.ai/latest/jan-mac-x64-0.4.8-325.dmg'>
<a href='https://delta.jan.ai/latest/jan-mac-x64-0.4.9-334.dmg'>
<img src='./docs/static/img/mac.png' style="height:15px; width: 15px" />
<b>Intel</b>
</a>
</td>
<td style="text-align:center">
<a href='https://delta.jan.ai/latest/jan-mac-arm64-0.4.8-325.dmg'>
<a href='https://delta.jan.ai/latest/jan-mac-arm64-0.4.9-334.dmg'>
<img src='./docs/static/img/mac.png' style="height:15px; width: 15px" />
<b>M1/M2</b>
</a>
</td>
<td style="text-align:center">
<a href='https://delta.jan.ai/latest/jan-linux-amd64-0.4.8-325.deb'>
<a href='https://delta.jan.ai/latest/jan-linux-amd64-0.4.9-334.deb'>
<img src='./docs/static/img/linux.png' style="height:14px; width: 14px" />
<b>jan.deb</b>
</a>
</td>
<td style="text-align:center">
<a href='https://delta.jan.ai/latest/jan-linux-x86_64-0.4.8-325.AppImage'>
<a href='https://delta.jan.ai/latest/jan-linux-x86_64-0.4.9-334.AppImage'>
<img src='./docs/static/img/linux.png' style="height:14px; width: 14px" />
<b>jan.AppImage</b>
</a>
@ -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

2
core/package.json
View File

@ -46,7 +46,7 @@
},
"devDependencies": {
"@types/jest": "^29.5.12",
"@types/node": "^12.0.2",
"@types/node": "^20.11.4",
"eslint": "8.57.0",
"eslint-plugin-jest": "^27.9.0",
"jest": "^29.7.0",

4
core/src/api/index.ts
View File

@ -33,7 +33,7 @@ export enum AppRoute {
stopServer = 'stopServer',
log = 'log',
logServer = 'logServer',
systemInformations = 'systemInformations',
systemInformation = 'systemInformation',
showToast = 'showToast',
}
@ -95,6 +95,8 @@ export enum FileManagerRoute {
getUserHomePath = 'getUserHomePath',
fileStat = 'fileStat',
writeBlob = 'writeBlob',
mkdir = 'mkdir',
rm = 'rm',
}
export type ApiFunction = (...args: any[]) => any

7
core/src/core.ts
View File

@ -1,4 +1,4 @@
import { DownloadRequest, FileStat, NetworkConfig } from './types'
import { DownloadRequest, FileStat, NetworkConfig, SystemInformation } from './types'
/**
* Execute a extension module function in main process
@ -110,7 +110,8 @@ const isSubdirectory: (from: string, to: string) => Promise<boolean> = (from: st
* Get system information
* @returns {Promise<any>} - A promise that resolves with the system information.
*/
const systemInformations: () => Promise<any> = () => global.core.api?.systemInformations()
const systemInformation: () => Promise<SystemInformation> = () =>
global.core.api?.systemInformation()
/**
* Show toast message from browser processes.
@ -146,7 +147,7 @@ export {
log,
isSubdirectory,
getUserHomePath,
systemInformations,
systemInformation,
showToast,
FileStat,
}

8
core/src/extension.ts
View File

@ -19,6 +19,7 @@ export interface Compatibility {
const ALL_INSTALLATION_STATE = [
'NotRequired', // not required.
'Installed', // require and installed. Good to go.
'Updatable', // require and installed but need to be updated.
'NotInstalled', // require to be installed.
'Corrupted', // require but corrupted. Need to redownload.
] as const
@ -59,6 +60,13 @@ export abstract class BaseExtension implements ExtensionType {
return undefined
}
/**
* Determine if the extension is updatable.
*/
updatable(): boolean {
return false
}
/**
* Determine if the prerequisites for the extension are installed.
*

6
core/src/extensions/ai-engines/LocalOAIEngine.ts
View File

@ -1,4 +1,4 @@
import { executeOnMain, getJanDataFolderPath, joinPath } from '../../core'
import { executeOnMain, getJanDataFolderPath, joinPath, systemInformation } from '../../core'
import { events } from '../../events'
import { Model, ModelEvent } from '../../types'
import { OAIEngine } from './OAIEngine'
@ -30,11 +30,11 @@ export abstract class LocalOAIEngine extends OAIEngine {
if (model.engine.toString() !== this.provider) return
const modelFolder = await joinPath([await getJanDataFolderPath(), this.modelFolder, model.id])
const systemInfo = await systemInformation()
const res = await executeOnMain(this.nodeModule, this.loadModelFunctionName, {
modelFolder,
model,
})
}, systemInfo)
if (res?.error) {
events.emit(ModelEvent.OnModelFail, {

3
core/src/extensions/monitoring.ts
View File

@ -1,5 +1,5 @@
import { BaseExtension, ExtensionTypeEnum } from '../extension'
import { GpuSetting, MonitoringInterface } from '../index'
import { GpuSetting, MonitoringInterface, OperatingSystemInfo } from '../index'
/**
* Monitoring extension for system monitoring.
@ -16,4 +16,5 @@ export abstract class MonitoringExtension extends BaseExtension implements Monit
abstract getGpuSetting(): Promise<GpuSetting>
abstract getResourcesInfo(): Promise<any>
abstract getCurrentLoad(): Promise<any>
abstract getOsInfo(): Promise<OperatingSystemInfo>
}

7
core/src/fs.ts
View File

@ -37,12 +37,17 @@ const readdirSync = (...args: any[]) => global.core.api?.readdirSync(...args)
*/
const mkdirSync = (...args: any[]) => global.core.api?.mkdirSync(...args)
const mkdir = (...args: any[]) => global.core.api?.mkdir(...args)
/**
* Removes a directory at the specified path.
* @returns {Promise<any>} A Promise that resolves when the directory is removed successfully.
*/
const rmdirSync = (...args: any[]) =>
global.core.api?.rmdirSync(...args, { recursive: true, force: true })
const rm = (path: string) => global.core.api?.rm(path)
/**
* Deletes a file from the local file system.
* @param {string} path - The path of the file to delete.
@ -92,7 +97,9 @@ export const fs = {
existsSync,
readdirSync,
mkdirSync,
mkdir,
rmdirSync,
rm,
unlinkSync,
appendFileSync,
copyFileSync,

24
core/src/node/api/processors/fsExt.ts
View File

@ -88,4 +88,28 @@ export class FSExt implements Processor {
})
})
}
mkdir(path: string): Promise<void> {
return new Promise((resolve, reject) => {
fs.mkdir(path, { recursive: true }, (err) => {
if (err) {
reject(err)
} else {
resolve()
}
})
})
}
rmdir(path: string): Promise<void> {
return new Promise((resolve, reject) => {
fs.rm(path, { recursive: true }, (err) => {
if (err) {
reject(err)
} else {
resolve()
}
})
})
}
}

19
core/src/node/extension/store.ts
View File

@ -93,8 +93,7 @@ export function persistExtensions() {
*/
export async function installExtensions(extensions: any) {
const installed: Extension[] = []
for (const ext of extensions) {
// Set install options and activation based on input type
const installations = extensions.map((ext: any): Promise<void> => {
const isObject = typeof ext === 'object'
const spec = isObject ? [ext.specifier, ext] : [ext]
const activate = isObject ? ext.activate !== false : true
@ -102,15 +101,17 @@ export async function installExtensions(extensions: any) {
// Install and possibly activate extension
const extension = new Extension(...spec)
if (!extension.origin) {
continue
return Promise.resolve()
}
await extension._install()
if (activate) extension.setActive(true)
return extension._install().then(() => {
if (activate) extension.setActive(true)
// Add extension to store if needed
addExtension(extension)
installed.push(extension)
})
})
// Add extension to store if needed
addExtension(extension)
installed.push(extension)
}
await Promise.all(installations)
// Return list of all installed extensions
return installed

50
core/src/node/helper/config.ts
View File

@ -82,26 +82,34 @@ export const getJanExtensionsPath = (): string => {
*/
export const physicalCpuCount = async (): Promise<number> => {
const platform = os.platform()
if (platform === 'linux') {
const output = await exec('lscpu -p | egrep -v "^#" | sort -u -t, -k 2,4 | wc -l')
return parseInt(output.trim(), 10)
} else if (platform === 'darwin') {
const output = await exec('sysctl -n hw.physicalcpu_max')
return parseInt(output.trim(), 10)
} else if (platform === 'win32') {
const output = await exec('WMIC CPU Get NumberOfCores')
return output
.split(os.EOL)
.map((line: string) => parseInt(line))
.filter((value: number) => !isNaN(value))
.reduce((sum: number, number: number) => sum + number, 1)
} else {
const cores = os.cpus().filter((cpu: any, index: number) => {
const hasHyperthreading = cpu.model.includes('Intel')
const isOdd = index % 2 === 1
return !hasHyperthreading || isOdd
})
return cores.length
try {
if (platform === 'linux') {
const output = await exec('lscpu -p | egrep -v "^#" | sort -u -t, -k 2,4 | wc -l')
return parseInt(output.trim(), 10)
} else if (platform === 'darwin') {
const output = await exec('sysctl -n hw.physicalcpu_max')
return parseInt(output.trim(), 10)
} else if (platform === 'win32') {
const output = await exec('WMIC CPU Get NumberOfCores')
return output
.split(os.EOL)
.map((line: string) => parseInt(line))
.filter((value: number) => !isNaN(value))
.reduce((sum: number, number: number) => sum + number, 1)
} else {
const cores = os.cpus().filter((cpu: any, index: number) => {
const hasHyperthreading = cpu.model.includes('Intel')
const isOdd = index % 2 === 1
return !hasHyperthreading || isOdd
})
return cores.length
}
} catch (err) {
console.warn('Failed to get physical CPU count', err)
// Divide by 2 to get rid of hyper threading
const coreCount = Math.ceil(os.cpus().length / 2)
console.debug('Using node API to get physical CPU count:', coreCount)
return coreCount
}
}
@ -118,7 +126,7 @@ const exec = async (command: string): Promise<string> => {
}
export const getEngineConfiguration = async (engineId: string) => {
if (engineId !== 'openai') {
if (engineId !== 'openai' && engineId !== 'groq') {
return undefined
}
const directoryPath = join(getJanDataFolderPath(), 'engines')

2
core/src/node/helper/resource.ts
View File

@ -1,6 +1,6 @@
import { SystemResourceInfo } from '../../types'
import { physicalCpuCount } from './config'
import { log, logServer } from './log'
import { log } from './log'
export const getSystemResourceInfo = async (): Promise<SystemResourceInfo> => {
const cpu = await physicalCpuCount()

24
core/src/types/miscellaneous/systemResourceInfo.ts
View File

@ -30,3 +30,27 @@ export type GpuSettingInfo = {
name: string
arch?: string
}
export type SystemInformation = {
gpuSetting: GpuSetting
osInfo?: OperatingSystemInfo
}
export const SupportedPlatforms = ['win32', 'linux', 'darwin'] as const
export type SupportedPlatformTuple = typeof SupportedPlatforms
export type SupportedPlatform = SupportedPlatformTuple[number]
export type OperatingSystemInfo = {
platform: SupportedPlatform | 'unknown'
arch: string
release: string
machine: string
version: string
totalMem: number
freeMem: number
}
export type CpuCoreInfo = {
model: string
speed: number
}

1
core/src/types/model/modelEntity.ts
View File

@ -18,6 +18,7 @@ export type ModelInfo = {
export enum InferenceEngine {
nitro = 'nitro',
openai = 'openai',
groq = 'groq',
triton_trtllm = 'triton_trtllm',
nitro_tensorrt_llm = 'nitro-tensorrt-llm',

15
docs/blog/01-january-10-2024-bitdefender-false-positive-flag.mdx
View File

@ -5,6 +5,21 @@ slug: /postmortems/january-10-2024-bitdefender-false-positive-flag
tags: [Postmortem]
---
<head>
<title>Jan 10, 2024 Incident Postmortem - Bitdefender False Positive Flag on Jan AI Resolved</title>
<meta charSet="utf-8" />
<meta name="description" content="Comprehensive postmortem on the Jan AI v0.4.4 Bitdefender false positive incident on January 10, 2024. Learn about the investigation, solutions, and preventive measures." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, postmortem, incident, flagging issue" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/blog/postmortems/january-10-2024-bitdefender-false-positive-flag/" />
<meta property="og:title" content="Bitdefender False Positive Flag on Jan AI Resolved - Jan 10, 2024 Incident Postmortem" />
<meta property="og:description" content="Comprehensive postmortem on the Jan AI v0.4.4 Bitdefender false positive incident on January 10, 2024. Learn about the investigation, solutions, and preventive measures." />
<meta property="og:url" content="https://jan.ai/blog/postmortems/january-10-2024-bitdefender-false-positive-flag/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>
Following the recent incident related to Jan version 0.4.4 triggering Bitdefender on Windows with Gen:Variant.Tedy.258323 on January 10, 2024, we wanted to provide a comprehensive postmortem and outline the necessary follow-up actions.
## Incident Overview

14
docs/docs/about/2035.mdx
View File

@ -2,6 +2,20 @@
title: Jan's Vision for 2035
---
<head>
<title>Jan's Vision for 2035</title>
<meta charset="utf-8" />
<meta name="description" content="Discover Jan's vision for the year 2035, where it aims to transform into a robotics company. Learn about its planning parameters, 10-year vision, 2-week sprint, and success measurement through Quarterly OKRs." />
<meta name="keywords" content="Jan, vision, 2035, robotics company, planning parameters, 10-year vision, 2-week sprint, Quarterly OKRs" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/jans-vision-for-2035" />
<meta property="og:title" content="Jan's Vision for 2035" />
<meta property="og:description" content="Discover Jan's vision for the year 2035, where it aims to transform into a robotics company. Learn about its planning parameters, 10-year vision, 2-week sprint, and success measurement through Quarterly OKRs." />
<meta property="og:url" content="https://jan.ai/jans-vision-for-2035" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-jans-vision.png" />
</head>
[Jan 2035: A Robotics Company](https://hackmd.io/QIWyYbNNQVWVbupuI3kjAA)
We only have 2 planning parameters:

14
docs/docs/about/about.md
View File

@ -18,6 +18,20 @@ keywords:
]
---
<head>
<title>About Jan</title>
<meta charset="utf-8" />
<meta name="description" content="Discover Jan, a desktop application that turns computers into thinking machines. Learn about its features, principles, vision, and how to get involved with the Jan Labs team." />
<meta name="keywords" content="Jan, Jan AI, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, desktop application, thinking machine, about Jan" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/about" />
<meta property="og:title" content="About Jan" />
<meta property="og:description" content="Discover Jan, a desktop application that turns computers into thinking machines. Learn about its features, principles, vision, and how to get involved with the Jan Labs team." />
<meta property="og:url" content="https://jan.ai/about" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-about-jan.png" />
</head>
Jan turns computers into thinking machines to change how we use them.
Jan is created and maintained by Jan Labs, a robotics company.

18
docs/docs/about/faq.md
View File

@ -1,3 +1,21 @@
---
title: Frequently Asked Questions (FAQ) - Jan
---
<head>
<title>Frequently Asked Questions (FAQ)</title>
<meta charset="utf-8" />
<meta name="description" content="Explore frequently asked questions about Jan, including its features, compatibility, privacy policy, usage, and community involvement." />
<meta name="keywords" content="Jan, frequently asked questions, FAQ, about Jan, usage, compatibility, privacy, community, contribution, troubleshooting, self-hosting, hiring" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/faq" />
<meta property="og:title" content="Frequently Asked Questions (FAQ)" />
<meta property="og:description" content="Explore frequently asked questions about Jan, including its features, compatibility, privacy policy, usage, and community involvement." />
<meta property="og:url" content="https://jan.ai/faq" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-faq.png" />
</head>
# Frequently Asked Questions (FAQ)
## What is Jan?

16
docs/docs/about/roadmap.md
View File

@ -2,5 +2,19 @@
title: Roadmap
---
<head>
<title>Roadmap</title>
<meta charset="utf-8" />
<meta name="description" content="Explore Jan's roadmap to see the immediate and longer-term plans for development and features." />
<meta name="keywords" content="Jan, roadmap, development, features, immediate roadmap, longer-term roadmap, GitHub, Discord" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/roadmap" />
<meta property="og:title" content="Roadmap" />
<meta property="og:description" content="Explore Jan's roadmap to see the immediate and longer-term plans for development and features." />
<meta property="og:url" content="https://jan.ai/roadmap" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-roadmap.png" />
</head>
- [ ] [Immediate Roadmap on Github](https://github.com/orgs/janhq/projects/5/views/16)
- [ ] [Longer-term Roadmap on Discord](https://discord.gg/Ey62mynnYr)
- [ ] [Longer-term Roadmap on Discord](https://discord.gg/Ey62mynnYr)

12
docs/docs/acknowledgements.md
View File

@ -17,6 +17,17 @@ keywords:
]
---
<head>
<meta name="description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. Explore the third-party libraries that have contributed to the development of Jan."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, acknowledgements, third-party libraries"/>
<meta property="og:title" content="Acknowledgements - Jan"/>
<meta property="og:description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. Explore the third-party libraries that have contributed to the development of Jan."/>
<meta property="og:url" content="https://jan.ai/acknowledgements"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Acknowledgements - Jan"/>
<meta name="twitter:description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. Explore the third-party libraries that have contributed to the development of Jan."/>
</head>
# Acknowledgements
We would like to express our gratitude to the following third-party libraries that have made the development of Jan possible.
@ -24,3 +35,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)

14
docs/docs/community/community.mdx
View File

@ -15,6 +15,20 @@ keywords:
]
---
<head>
<title>Jan's Community</title>
<meta charset="utf-8" />
<meta name="description" content="Join Jan's community to connect with other users, stay updated, and explore career opportunities." />
<meta name="keywords" content="Jan, community, Discord, Twitter, HuggingFace, LinkedIn, Reddit, newsletter, careers" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/community" />
<meta property="og:title" content="Jan's Community" />
<meta property="og:description" content="Join Jan's community to connect with other users, stay updated, and explore career opportunities." />
<meta property="og:url" content="https://jan.ai/community" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-community.png" />
</head>
## Socials
- [Discord](https://discord.gg/SH3DGmUs6b)

14
docs/docs/developer/01-overview/01-architecture.md
View File

@ -15,6 +15,20 @@ keywords:
]
---
<head>
<title>Jan AI Architecture - Modular and Extensible Framework</title>
<meta charSet="utf-8" />
<meta name="description" content="Discover the modular architecture of Jan, a ChatGPT alternative that runs on your own computer. Learn about Jan's local API server, Desktop UI, and the Nitro inference engine." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, modular architecture, Extensions API" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/developer/architecture/" />
<meta property="og:title" content="Jan AI Architecture - Modular and Extensible Framework" />
<meta property="og:description" content="Discover the modular architecture of Jan, a ChatGPT alternative that runs on your own computer. Learn about Jan's local API server, Desktop UI, and the Nitro inference engine." />
<meta property="og:url" content="https://jan.ai/developer/architecture/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>
:::warning
This page is still under construction, and should be read as a scratchpad

14
docs/docs/developer/01-overview/02-file-based.md
View File

@ -15,6 +15,20 @@ keywords:
]
---
<head>
<title>Jan AI File-based Data Persistence Approach</title>
<meta charSet="utf-8" />
<meta name="description" content="Learn how Jan, a ChatGPT alternative, leverages a local filesystem for data persistence, promoting composability and tinkerability similar to VSCode." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, file-based data storage, data persistence" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/developer/file-based/" />
<meta property="og:title" content="Jan AI File-based Data Persistence Approach" />
<meta property="og:description" content="Learn how Jan, a ChatGPT alternative, leverages a local filesystem for data persistence, promoting composability and tinkerability similar to VSCode." />
<meta property="og:url" content="https://jan.ai/developer/file-based/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>
:::warning
This page is still under construction, and should be read as a scratchpad

14
docs/docs/developer/01-overview/03-user-interface.md
View File

@ -15,6 +15,20 @@ keywords:
]
---
<head>
<title>Jan AI User Interface - Customizable UI Kit</title>
<meta charSet="utf-8" />
<meta name="description" content="Explore Jan's UI Kit for customizing the user interface to fit your brand and style. Learn how to personalize your application with Jan's flexible UI components." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, UI Kit, customizable UI" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/developer/ui/" />
<meta property="og:title" content="Jan AI User Interface - Customizable UI Kit" />
<meta property="og:description" content="Explore Jan's UI Kit for customizing the user interface to fit your brand and style. Learn how to personalize your application with Jan's flexible UI components." />
<meta property="og:url" content="https://jan.ai/developer/ui/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>
:::warning
This page is still under construction, and should be read as a scratchpad

14
docs/docs/developer/01-overview/04-install-and-prerequisites.md
View File

@ -18,6 +18,20 @@ keywords:
]
---
<head>
<title>Jan AI Installation and Setup Guide - Developer Prerequisites</title>
<meta charSet="utf-8" />
<meta name="description" content="Comprehensive guide to installing and setting up Jan for development. Covers hardware, system requirements, and step-by-step instructions for developers." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, installation, prerequisites, developer setup" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/developer/prereq/" />
<meta property="og:title" content="Jan AI Installation and Setup Guide - Developer Prerequisites" />
<meta property="og:description" content="Comprehensive guide to installing and setting up Jan for development. Covers hardware, system requirements, and step-by-step instructions for developers." />
<meta property="og:url" content="https://jan.ai/developer/prereq/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>
## Requirements
### Hardware Requirements

14
docs/docs/developer/01-overview/README.md
View File

@ -15,6 +15,20 @@ keywords:
]
---
<head>
<title>Jan AI Developer Documentation - Building Extensions and SDK Overview</title>
<meta charSet="utf-8" />
<meta name="description" content="Guide for developers on building extensions on top of the Jan Framework. Learn about Jan's extensible framework for AI applications, available on all platforms." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, extensible framework, SDK, building extensions" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/developer/" />
<meta property="og:title" content="Jan AI Developer Documentation - Building Extensions and SDK Overview" />
<meta property="og:description" content="Guide for developers on building extensions on top of the Jan Framework. Learn about Jan's extensible framework for AI applications, available on all platforms." />
<meta property="og:url" content="https://jan.ai/developer/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>
The following docs are aimed at developers who want to build extensions on top of the Jan Framework.
:::tip

15
docs/docs/developer/02-build-assistant/01-your-first-assistant.md
View File

@ -17,7 +17,20 @@ keywords:
]
---
<head>
<title>Your First Assistant</title>
<meta charset="utf-8" />
<meta name="description" content="Get started quickly with building your first assistant using Jan. Learn the basics of creating conversational AI." />
<meta name="keywords" content="Jan, build assistant, quick start, conversational AI, local AI, private AI, large language model" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/developer/build-assistant/your-first-assistant/" />
<meta property="og:title" content="Your First Assistant" />
<meta property="og:description" content="Get started quickly with building your first assistant using Jan. Learn the basics of creating conversational AI." />
<meta property="og:url" content="https://jan.ai/developer/build-assistant/your-first-assistant/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-first-assistant.png" />
</head>
:::caution
This is currently under development.
:::

20
docs/docs/developer/04-build-extension/01-your-first-extension.md
View File

@ -17,6 +17,20 @@ keywords:
]
---
<head>
<title>Building Your First Jan AI Extension - Quick Start Guide</title>
<meta charSet="utf-8" />
<meta name="description" content="Step-by-step guide on how to build your first extension for Jan AI. Learn how to use the extension template and integrate your custom functionality into Jan." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, quick start, build extension" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/developer/build-extension/your-first-extension/" />
<meta property="og:title" content="Building Your First Jan AI Extension - Quick Start Guide" />
<meta property="og:description" content="Step-by-step guide on how to build your first extension for Jan AI. Learn how to use the extension template and integrate your custom functionality into Jan." />
<meta property="og:url" content="https://jan.ai/developer/build-extension/your-first-extension/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>
:::caution
This is currently under development.
:::
@ -76,13 +90,13 @@ There are a few things to keep in mind when writing your extension code:
In `index.ts`, you will see that the extension function will return a `Promise<any>`.
```typescript
import { core } from "@janhq/core";
import { core } from '@janhq/core'
function onStart(): Promise<any> {
return core.invokePluginFunc(MODULE_PATH, "run", 0);
return core.invokePluginFunc(MODULE_PATH, 'run', 0)
}
```
For more information about the Jan Extension Core module, see the [documentation](https://github.com/janhq/jan/blob/main/core/README.md).
Now, go ahead and start customizing your extension! Happy coding!
Now, go ahead and start customizing your extension! Happy coding!

15
docs/docs/developer/05-framework/03-engineering/assistants.md
View File

@ -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:
]
---
<head>
<title>Assistants</title>
<meta charset="utf-8" />
<meta name="description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/assistants" />
<meta property="og:title" content="Assistants" />
<meta property="og:description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server." />
<meta property="og:url" content="https://jan.ai/assistants" />
<meta property="og:type" content="article" />
</head>
:::caution
This is currently under development.

13
docs/docs/developer/05-framework/03-engineering/chats.md
View File

@ -14,6 +14,19 @@ keywords:
]
---
<head>
<title>Chats</title>
<meta charset="utf-8" />
<meta name="description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/chats" />
<meta property="og:title" content="Chats" />
<meta property="og:description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server." />
<meta property="og:url" content="https://jan.ai/chats" />
<meta property="og:type" content="article" />
</head>
:::caution
This is currently under development.

13
docs/docs/developer/05-framework/03-engineering/engine.md
View File

@ -2,6 +2,19 @@
title: Engine
---
<head>
<title>Engine</title>
<meta charset="utf-8" />
<meta name="description" content="Currently Under Development" />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/engine" />
<meta property="og:title" content="Engine" />
<meta property="og:description" content="Currently Under Development" />
<meta property="og:url" content="https://jan.ai/engine" />
<meta property="og:type" content="article" />
</head>
:::caution
Currently Under Development

15
docs/docs/developer/05-framework/03-engineering/files.md
View File

@ -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:
]
---
<head>
<title>Files</title>
<meta charset="utf-8" />
<meta name="description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/files" />
<meta property="og:title" content="Files" />
<meta property="og:description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server." />
<meta property="og:url" content="https://jan.ai/files" />
<meta property="og:type" content="article" />
</head>
:::warning
Draft Specification: functionality has not been implemented yet.

13
docs/docs/developer/05-framework/03-engineering/messages.md
View File

@ -14,6 +14,19 @@ keywords:
]
---
<head>
<title>Messages</title>
<meta charset="utf-8" />
<meta name="description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/messages" />
<meta property="og:title" content="Messages" />
<meta property="og:description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server." />
<meta property="og:url" content="https://jan.ai/messages" />
<meta property="og:type" content="article" />
</head>
:::caution
This is currently under development.

13
docs/docs/developer/05-framework/03-engineering/models.md
View File

@ -14,6 +14,19 @@ keywords:
]
---
<head>
<title>Models</title>
<meta charset="utf-8" />
<meta name="description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/models" />
<meta property="og:title" content="Models" />
<meta property="og:description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server." />
<meta property="og:url" content="https://jan.ai/models" />
<meta property="og:type" content="article" />
</head>
:::caution
This is currently under development.

13
docs/docs/developer/05-framework/03-engineering/threads.md
View File

@ -14,6 +14,19 @@ keywords:
]
---
<head>
<title>Threads</title>
<meta charset="utf-8" />
<meta name="description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/threads" />
<meta property="og:title" content="Threads" />
<meta property="og:description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server." />
<meta property="og:url" content="https://jan.ai/threads" />
<meta property="og:type" content="article" />
</head>
:::caution
This is currently under development.

13
docs/docs/developer/05-framework/03-product/chat.md
View File

@ -14,6 +14,19 @@ keywords:
]
---
<head>
<title>Chat</title>
<meta charset="utf-8" />
<meta name="description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/chat" />
<meta property="og:title" content="Chat" />
<meta property="og:description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server." />
<meta property="og:url" content="https://jan.ai/chat" />
<meta property="og:type" content="article" />
</head>
## Overview
A home screen for users to chat with [assistants](/docs/engineering/assistants) via conversation [threads](/docs/engineering/threads).

13
docs/docs/developer/05-framework/03-product/hub.md
View File

@ -14,6 +14,19 @@ keywords:
]
---
<head>
<title>Hub</title>
<meta charset="utf-8" />
<meta name="description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/hub" />
<meta property="og:title" content="Hub" />
<meta property="og:description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server." />
<meta property="og:url" content="https://jan.ai/hub" />
<meta property="og:type" content="article" />
</head>
## Overview
The Hub is like a store for everything, where users can discover and download models, assistants, and more.

13
docs/docs/developer/05-framework/03-product/jan.md
View File

@ -14,6 +14,19 @@ keywords:
]
---
<head>
<title>Jan (The Default Assistant)</title>
<meta charset="utf-8" />
<meta name="description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/jan" />
<meta property="og:title" content="Jan (The Default Assistant)" />
<meta property="og:description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server." />
<meta property="og:url" content="https://jan.ai/jan" />
<meta property="og:type" content="article" />
</head>
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

13
docs/docs/developer/05-framework/03-product/settings.md
View File

@ -14,6 +14,19 @@ keywords:
]
---
<head>
<title>Settings</title>
<meta charset="utf-8" />
<meta name="description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/settings" />
<meta property="og:title" content="Settings" />
<meta property="og:description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server." />
<meta property="og:url" content="https://jan.ai/settings" />
<meta property="og:type" content="article" />
</head>
## Overview
A settings page for users to add extensions, configure model settings, change app appearance, add keyboard shortcuts, and a plethora of other personalizations.

13
docs/docs/developer/05-framework/03-product/system-monitor.md
View File

@ -14,6 +14,19 @@ keywords:
]
---
<head>
<title>System Monitor</title>
<meta charset="utf-8" />
<meta name="description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/system-monitor" />
<meta property="og:title" content="System Monitor" />
<meta property="og:description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server." />
<meta property="og:url" content="https://jan.ai/system-monitor" />
<meta property="og:type" content="article" />
</head>
## Overview
An activity screen to monitor system health and running models.

15
docs/docs/events/hcmc-oct23.md
View File

@ -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
---
<head>
<title>Jan's AI Hacker House (Ho Chi Minh City)</title>
<meta charset="utf-8" />
<meta name="description" content="24-27 Oct 2023, District 3, HCMC. AI-focused talks, workshops and social events. Hosted by Jan.ai" />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/events/hcmc-oct23" />
<meta property="og:title" content="Jan's AI Hacker House (Ho Chi Minh City)" />
<meta property="og:description" content="24-27 Oct 2023, District 3, HCMC. AI-focused talks, workshops and social events. Hosted by Jan.ai" />
<meta property="og:url" content="https://jan.ai/events/hcmc-oct23" />
<meta property="og:type" content="article" />
</head>
![](/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/) 🎉

22
docs/docs/events/nvidia-llm-day-nov-23.md
View File

@ -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
---
<head>
<title>Nov 23: Nvidia GenAI Day</title>
<meta charset="utf-8" />
<meta name="description" content="Nvidia's LLM Day" />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/events/nvidia-genai-day" />
<meta property="og:title" content="Nov 23: Nvidia GenAI Day" />
<meta property="og:description" content="Nvidia's LLM Day" />
<meta property="og:url" content="https://jan.ai/events/nvidia-genai-day" />
<meta property="og:type" content="article" />
</head>
![](/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)

14
docs/docs/guides/advanced-settings/advanced-settings.mdx
View File

@ -15,6 +15,20 @@ keywords:
]
---
<head>
<title>Advanced Settings</title>
<meta name="description" content="This guide will show you how to use the advanced settings in Jan. Learn about keyboard shortcuts, experimental mode, GPU acceleration, Jan data folder access, HTTPS proxy configuration, SSL certificate handling, log clearing, and resetting to factory default settings."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, advanced-settings"/>
<meta property="og:title" content="Advanced Settings"/>
<meta property="og:description" content="This guide will show you how to use the advanced settings in Jan. Learn about keyboard shortcuts, experimental mode, GPU acceleration, Jan data folder access, HTTPS proxy configuration, SSL certificate handling, log clearing, and resetting to factory default settings."/>
<meta property="og:image" content="https://jan.ai/img/advanced-settings.png"/>
<meta property="og:url" content="https://jan.ai/advanced-settings"/>
<meta name="twitter:card" content="summary_large_image"/>
<meta name="twitter:title" content="Advanced Settings"/>
<meta name="twitter:description" content="This guide will show you how to use the advanced settings in Jan. Learn about keyboard shortcuts, experimental mode, GPU acceleration, Jan data folder access, HTTPS proxy configuration, SSL certificate handling, log clearing, and resetting to factory default settings."/>
<meta name="twitter:image" content="https://jan.ai/img/advanced-settings.png"/>
</head>
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

13
docs/docs/guides/advanced-settings/http-proxy.mdx
View File

@ -16,6 +16,19 @@ keywords:
]
---
<head>
<title>HTTPS Proxy</title>
<meta name="description" content="Learn how to set up an HTTPS proxy server for Jan AI to encrypt data between your browser and the internet, maintain privacy and security, and bypass regional restrictions."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, advanced-settings, https-proxy"/>
<meta property="og:title" content="HTTPS Proxy"/>
<meta property="og:description" content="Learn how to set up an HTTPS proxy server for Jan AI to encrypt data between your browser and the internet, maintain privacy and security, and bypass regional restrictions."/>
<meta property="og:image" content="https://jan.ai/img/https-proxy.png"/>
<meta property="og:url" content="https://jan.ai/https-proxy"/>
<meta name="twitter:card" content="summary_large_image"/>
<meta name="twitter:title" content="HTTPS Proxy"/>
<meta name="twitter:description" content="Learn how to set up an HTTPS proxy server for Jan AI to encrypt data between your browser and the internet, maintain privacy and security, and bypass regional restrictions."/>
<meta name="twitter:image" content="https://jan.ai/img/https-proxy.png"/>
</head>
## Why HTTPS Proxy?

12
docs/docs/guides/best-practices.mdx
View File

@ -17,6 +17,18 @@ keywords:
]
---
<head>
<title>Best Practices - Jan Guides</title>
<meta name="description" content="Comprehensive set of best practices for using Jan AI locally. Learn about setting up the right models, configuring Jan, mastering prompt engineering, and integrating Jan with other systems."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, best practices, quickstart guide, prompt engineering, integrations"/>
<meta property="og:title" content="Best Practices - Jan Guides"/>
<meta property="og:description" content="Comprehensive set of best practices for using Jan AI locally. Learn about setting up the right models, configuring Jan, mastering prompt engineering, and integrating Jan with other systems."/>
<meta property="og:url" content="https://jan.ai/guides/best-practices"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Best Practices - Jan Guides"/>
<meta name="twitter:description" content="Comprehensive set of best practices for using Jan AI locally. Learn about setting up the right models, configuring Jan, mastering prompt engineering, and integrating Jan with other systems."/>
</head>
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

20
docs/docs/guides/common-error/broken-build.mdx
View File

@ -17,6 +17,20 @@ keywords:
]
---
<head>
<title>Broken Build</title>
<meta name="description" content="A step-by-step guide to fix errors that prevent the project from compiling or running successfully. Learn how to troubleshoot and resolve issues where Jan gets stuck in a broken build after installation."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, troubleshooting"/>
<meta property="og:title" content="Broken Build"/>
<meta property="og:description" content="A step-by-step guide to fix errors that prevent the project from compiling or running successfully. Learn how to troubleshoot and resolve issues where Jan gets stuck in a broken build after installation."/>
<meta property="og:image" content="https://jan.ai/img/broken-build.png"/>
<meta property="og:url" content="https://jan.ai/broken-build"/>
<meta name="twitter:card" content="summary_large_image"/>
<meta name="twitter:title" content="Broken Build"/>
<meta name="twitter:description" content="A step-by-step guide to fix errors that prevent the project from compiling or running successfully. Learn how to troubleshoot and resolve issues where Jan gets stuck in a broken build after installation."/>
<meta name="twitter:image" content="https://jan.ai/img/broken-build.png"/>
</head>
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
@ -67,7 +81,11 @@ This guide provides you steps to troubleshoot and to resolve the issue where you
### 2. Delete Application Data, Cache, and User Data
```sh
# You can delete the `/Jan` directory in Windows's AppData Directory by visiting the following path `%APPDATA%\Jan`
# Delete your own user data
cd ~ # Or where you moved the Jan Data Folder to
rm -r ./jan
# Delete Application Cache
cd C:\Users\YOUR_USERNAME\AppData\Roaming
rm -r ./Jan
```

14
docs/docs/guides/common-error/not-using-gpu.mdx
View File

@ -17,6 +17,20 @@ keywords: [
]
---
<head>
<title>Troubleshooting NVIDIA GPU</title>
<meta name="description" content="A step-by-step guide to enable Jan to properly leverage NVIDIA GPU resources, avoiding performance issues. Learn how to troubleshoot and resolve issues when Jan does not utilize the NVIDIA GPU on Windows and Linux systems."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, troubleshooting, using GPU"/>
<meta property="og:title" content="Troubleshooting NVIDIA GPU"/>
<meta property="og:description" content="A step-by-step guide to enable Jan to properly leverage NVIDIA GPU resources, avoiding performance issues. Learn how to troubleshoot and resolve issues when Jan does not utilize the NVIDIA GPU on Windows and Linux systems."/>
<meta property="og:image" content="https://jan.ai/img/troubleshooting-nvidia-gpu.png"/>
<meta property="og:url" content="https://jan.ai/troubleshooting-nvidia-gpu"/>
<meta name="twitter:card" content="summary_large_image"/>
<meta name="twitter:title" content="Troubleshooting NVIDIA GPU"/>
<meta name="twitter:description" content="A step-by-step guide to enable Jan to properly leverage NVIDIA GPU resources, avoiding performance issues. Learn how to troubleshoot and resolve issues when Jan does not utilize the NVIDIA GPU on Windows and Linux systems."/>
<meta name="twitter:image" content="https://jan.ai/img/troubleshooting-nvidia-gpu.png"/>
</head>
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

14
docs/docs/guides/error-codes/how-to-get-error-logs.mdx
View File

@ -17,6 +17,20 @@ keywords:
]
---
<head>
<title>How to Get Error Logs</title>
<meta name="description" content="A step-by-step guide to get the Jan app error logs. Learn how to access error logs for Jan application, UI, and API server, along with precautions to redact sensitive information when sharing logs."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, troubleshooting, permission denied"/>
<meta property="og:title" content="How to Get Error Logs"/>
<meta property="og:description" content="A step-by-step guide to get the Jan app error logs. Learn how to access error logs for Jan application, UI, and API server, along with precautions to redact sensitive information when sharing logs."/>
<meta property="og:image" content="https://jan.ai/img/how-to-get-error-logs.png"/>
<meta property="og:url" content="https://jan.ai/how-to-get-error-logs"/>
<meta name="twitter:card" content="summary_large_image"/>
<meta name="twitter:title" content="How to Get Error Logs"/>
<meta name="twitter:description" content="A step-by-step guide to get the Jan app error logs. Learn how to access error logs for Jan application, UI, and API server, along with precautions to redact sensitive information when sharing logs."/>
<meta name="twitter:image" content="https://jan.ai/img/how-to-get-error-logs.png"/>
</head>
To get the error logs of your Jan application, follow the steps below:
### Jan Application
1. Navigate to the main dashboard.

14
docs/docs/guides/error-codes/no-assistant-available.mdx
View File

@ -17,6 +17,20 @@ keywords:
]
---
<head>
<title>No Assistant Available</title>
<meta name="description" content="Troubleshooting steps to resolve issues when encountering the 'No assistant available' error message in Jan. Learn how to identify and remove unintentional files in the /jan/assistants directory to resolve the issue."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, troubleshooting, no assistant available"/>
<meta property="og:title" content="No Assistant Available"/>
<meta property="og:description" content="Troubleshooting steps to resolve issues when encountering the 'No assistant available' error message in Jan. Learn how to identify and remove unintentional files in the /jan/assistants directory to resolve the issue."/>
<meta property="og:image" content="https://jan.ai/img/no-assistant-available.png"/>
<meta property="og:url" content="https://jan.ai/no-assistant-available"/>
<meta name="twitter:card" content="summary_large_image"/>
<meta name="twitter:title" content="No Assistant Available"/>
<meta name="twitter:description" content="Troubleshooting steps to resolve issues when encountering the 'No assistant available' error message in Jan. Learn how to identify and remove unintentional files in the /jan/assistants directory to resolve the issue."/>
<meta name="twitter:image" content="https://jan.ai/img/no-assistant-available.png"/>
</head>
When you encounter the following error message:
```
No assistant available.

16
docs/docs/guides/error-codes/permission-denied.mdx
View File

@ -17,7 +17,21 @@ keywords:
]
---
When running Jan, you might encounter the following error message:
<head>
<title>Resolving "Permission Denied" Error in Jan AI</title>
<meta charSet="utf-8" />
<meta name="description" content="Learn how to resolve the 'Permission Denied' error encountered while running Jan AI by changing ownership of the `~/.npm` directory to the current user." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, troubleshooting, permission denied" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/troubleshooting/permission-denied" />
<meta property="og:title" content="Resolving 'Permission Denied' Error in Jan AI" />
<meta property="og:description" content="Learn how to resolve the 'Permission Denied' error encountered while running Jan AI by changing ownership of the `~/.npm` directory to the current user." />
<meta property="og:url" content="https://jan.ai/troubleshooting/permission-denied" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>
When you run Jan, you may encounter the following error:
```
Uncaught (in promise) Error: Error invoking layout-480796bff433a3a3.js:538 remote method 'installExtension':

12
docs/docs/guides/error-codes/something-amiss.mdx
View File

@ -4,6 +4,18 @@ sidebar_position: 4
description: A step-by-step guide to resolve an unspecified or general error.
---
<head>
<title>Something's Amiss</title>
<meta name="description" content="A step-by-step guide to resolve an unspecified or general error encountered when starting a chat with a model in Jan. Learn how to troubleshoot and resolve common issues, such as ensuring OS updates, selecting appropriate model sizes, installing the latest Nightly release, checking V/RAM accessibility, downloading CUDA for Nvidia GPU users, and verifying port status."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, troubleshooting, something's amiss"/>
<meta property="og:title" content="Something's Amiss"/>
<meta property="og:description" content="A step-by-step guide to resolve an unspecified or general error encountered when starting a chat with a model in Jan. Learn how to troubleshoot and resolve common issues, such as ensuring OS updates, selecting appropriate model sizes, installing the latest Nightly release, checking V/RAM accessibility, downloading CUDA for Nvidia GPU users, and verifying port status."/>
<meta property="og:url" content="https://jan.ai/somethings-amiss"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Something's Amiss"/>
<meta name="twitter:description" content="A step-by-step guide to resolve an unspecified or general error encountered when starting a chat with a model in Jan. Learn how to troubleshoot and resolve common issues, such as ensuring OS updates, selecting appropriate model sizes, installing the latest Nightly release, checking V/RAM accessibility, downloading CUDA for Nvidia GPU users, and verifying port status."/>
</head>
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

12
docs/docs/guides/error-codes/stuck-on-loading-model.mdx
View File

@ -17,6 +17,18 @@ keywords:
]
---
<head>
<title>Stuck on Loading Model</title>
<meta name="description" content="Troubleshooting steps to resolve issues related to the loading model in Jan. Learn how to fix problems such as model loading stuck due to missing Windows Management Instrumentation Command-line (WMIC) path in the system's PATH environment variable or due to using CPUs without Advanced Vector Extensions (AVX) support."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, troubleshooting, stuck on loading model"/>
<meta property="og:title" content="Stuck on Loading Model"/>
<meta property="og:description" content="Troubleshooting steps to resolve issues related to the loading model in Jan. Learn how to fix problems such as model loading stuck due to missing Windows Management Instrumentation Command-line (WMIC) path in the system's PATH environment variable or due to using CPUs without Advanced Vector Extensions (AVX) support."/>
<meta property="og:url" content="https://jan.ai/stuck-on-loading-model"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Stuck on Loading Model"/>
<meta name="twitter:description" content="Troubleshooting steps to resolve issues related to the loading model in Jan. Learn how to fix problems such as model loading stuck due to missing Windows Management Instrumentation Command-line (WMIC) path in the system's PATH environment variable or due to using CPUs without Advanced Vector Extensions (AVX) support."/>
</head>
## 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.

12
docs/docs/guides/error-codes/thread-disappreance.mdx
View File

@ -17,6 +17,18 @@ keywords:
]
---
<head>
<title>Thread Disappearance</title>
<meta name="description" content="Troubleshooting steps to resolve issues with threads suddenly disappearing in Jan. Learn how to fix problems when old threads vanish due to the creation of new, unintentional files in the /jan/threads directory."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, troubleshooting, thread disappearance"/>
<meta property="og:title" content="Thread Disappearance"/>
<meta property="og:description" content="Troubleshooting steps to resolve issues with threads suddenly disappearing in Jan. Learn how to fix problems when old threads vanish due to the creation of new, unintentional files in the /jan/threads directory."/>
<meta property="og:url" content="https://jan.ai/thread-disappearance"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Thread Disappearance"/>
<meta name="twitter:description" content="Troubleshooting steps to resolve issues with threads suddenly disappearing in Jan. Learn how to fix problems when old threads vanish due to the creation of new, unintentional files in the /jan/threads directory."/>
</head>
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:

12
docs/docs/guides/error-codes/undefined-issue.mdx
View File

@ -17,6 +17,18 @@ keywords:
]
---
<head>
<title>Undefined Issue</title>
<meta name="description" content="A step-by-step guide to resolve errors when a variable or object is not defined in Jan. Learn how to troubleshoot and fix issues related to undefined variables or objects caused by Nitro tool or other internal processes."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, troubleshooting, undefined issue"/>
<meta property="og:title" content="Undefined Issue"/>
<meta property="og:description" content="A step-by-step guide to resolve errors when a variable or object is not defined in Jan. Learn how to troubleshoot and fix issues related to undefined variables or objects caused by Nitro tool or other internal processes."/>
<meta property="og:url" content="https://jan.ai/undefined-issue"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Undefined Issue"/>
<meta name="twitter:description" content="A step-by-step guide to resolve errors when a variable or object is not defined in Jan. Learn how to troubleshoot and fix issues related to undefined variables or objects caused by Nitro tool or other internal processes."/>
</head>
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

12
docs/docs/guides/error-codes/unexpected-token.mdx
View File

@ -17,6 +17,18 @@ keywords:
]
---
<head>
<title>Unexpected Token</title>
<meta name="description" content="A step-by-step guide to correct syntax errors caused by invalid JSON in the code. Learn how to troubleshoot and fix issues related to unexpected token errors when initiating a chat with OpenAI models."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, troubleshooting, unexpected token"/>
<meta property="og:title" content="Unexpected Token"/>
<meta property="og:description" content="A step-by-step guide to correct syntax errors caused by invalid JSON in the code. Learn how to troubleshoot and fix issues related to unexpected token errors when initiating a chat with OpenAI models."/>
<meta property="og:url" content="https://jan.ai/unexpected-token"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Unexpected Token"/>
<meta name="twitter:description" content="A step-by-step guide to correct syntax errors caused by invalid JSON in the code. Learn how to troubleshoot and fix issues related to unexpected token errors when initiating a chat with OpenAI models."/>
</head>
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.

13
docs/docs/guides/extensions/setup-ext.mdx
View File

@ -16,6 +16,19 @@ keywords:
]
---
<head>
<title>Configuring Extension Settings in Jan AI - User Guide</title>
<meta charSet="utf-8" />
<meta name="description" content="Learn how to configure settings for default extensions in Jan AI, including how to enable/disable extensions and modify their configurations." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, extension settings" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/guides/using-extensions/extension-settings/" />
<meta property="og:title" content="Configuring Extension Settings in Jan AI - User Guide" />
<meta property="og:description" content="Learn how to configure settings for default extensions in Jan AI, including how to enable/disable extensions and modify their configurations." />
<meta property="og:url" content="https://jan.ai/guides/using-extensions/extension-settings/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>
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.

12
docs/docs/guides/faq.mdx
View File

@ -17,6 +17,18 @@ keywords:
]
---
<head>
<title>FAQs - Jan Guides</title>
<meta name="description" content="Frequently asked questions (FAQs) about Jan AI, covering general issues, download and installation issues, technical issues and solutions, compatibility and support, development and features, and troubleshooting."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, FAQs, troubleshooting, technical issues, compatibility, development"/>
<meta property="og:title" content="FAQs - Jan Guides"/>
<meta property="og:description" content="Frequently asked questions (FAQs) about Jan AI, covering general issues, download and installation issues, technical issues and solutions, compatibility and support, development and features, and troubleshooting."/>
<meta property="og:url" content="https://jan.ai/guides/faqs"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="FAQs - Jan Guides"/>
<meta name="twitter:description" content="Frequently asked questions (FAQs) about Jan AI, covering general issues, download and installation issues, technical issues and solutions, compatibility and support, development and features, and troubleshooting."/>
</head>
## General Issues
- **Why can't I download models like Pandora 11B Q4 and Solar Instruct 10.7B Q4?**

12
docs/docs/guides/install.mdx
View File

@ -16,6 +16,18 @@ keywords:
]
---
<head>
<title>Installation - Jan Guides</title>
<meta name="description" content="Instructions for installing Jan AI on Mac, Windows, Linux, and Docker, along with prerequisites and considerations for each platform."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, installation, macOS, Windows, Linux, Docker"/>
<meta property="og:title" content="Installation - Jan Guides"/>
<meta property="og:description" content="Instructions for installing Jan AI on Mac, Windows, Linux, and Docker, along with prerequisites and considerations for each platform."/>
<meta property="og:url" content="https://jan.ai/guides/installation"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Installation - Jan Guides"/>
<meta name="twitter:description" content="Instructions for installing Jan AI on Mac, Windows, Linux, and Docker, along with prerequisites and considerations for each platform."/>
</head>
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import installImageURL from './assets/jan-ai-download.png';

12
docs/docs/guides/integration/azure.mdx
View File

@ -17,6 +17,18 @@ keywords:
]
---
<head>
<title>Azure OpenAI</title>
<meta name="description" content="A step-by-step guide on how to integrate Jan with Azure OpenAI. Learn how to configure Azure OpenAI Service API key, set up model configuration, and start the model in Jan."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, integration, Azure OpenAI Service"/>
<meta property="og:title" content="Azure OpenAI"/>
<meta property="og:description" content="A step-by-step guide on how to integrate Jan with Azure OpenAI. Learn how to configure Azure OpenAI Service API key, set up model configuration, and start the model in Jan."/>
<meta property="og:url" content="https://jan.ai/azure-openai"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Azure OpenAI"/>
<meta name="twitter:description" content="A step-by-step guide on how to integrate Jan with Azure OpenAI. Learn how to configure Azure OpenAI Service API key, set up model configuration, and start the model in Jan."/>
</head>
## 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:

12
docs/docs/guides/integration/discord.mdx
View File

@ -4,6 +4,18 @@ sidebar_position: 5
description: A step-by-step guide on how to integrate Jan with a Discord bot.
---
<head>
<title>Discord</title>
<meta name="description" content="A step-by-step guide on how to integrate Jan with a Discord bot. Learn how to clone the repository, install required libraries, set up the environment, insert the bot into Discord server, and run the bot."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, integration, Discord, Discord bot"/>
<meta property="og:title" content="Discord"/>
<meta property="og:description" content="A step-by-step guide on how to integrate Jan with a Discord bot. Learn how to clone the repository, install required libraries, set up the environment, insert the bot into Discord server, and run the bot."/>
<meta property="og:url" content="https://jan.ai/discord"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Discord"/>
<meta name="twitter:description" content="A step-by-step guide on how to integrate Jan with a Discord bot. Learn how to clone the repository, install required libraries, set up the environment, insert the bot into Discord server, and run the bot."/>
</head>
## 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.

12
docs/docs/guides/integration/groq.mdx
View File

@ -17,6 +17,18 @@ keywords:
]
---
<head>
<title>Groq</title>
<meta name="description" content="Learn how to integrate Groq API with Jan for enhanced functionality. Follow step-by-step instructions to obtain Groq API credentials, configure Jan settings, enable Groq integration, and troubleshoot any issues."/>
<meta name="keywords" content="Groq API, Jan, Jan AI, ChatGPT alternative, conversational AI, large language model, integration, Groq integration, API integration"/>
<meta property="og:title" content="Groq"/>
<meta property="og:description" content="Learn how to integrate Groq API with Jan for enhanced functionality. Follow step-by-step instructions to obtain Groq API credentials, configure Jan settings, enable Groq integration, and troubleshoot any issues."/>
<meta property="og:url" content="https://jan.ai/guides/integration/groq"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Groq"/>
<meta name="twitter:description" content="Learn how to integrate Groq API with Jan for enhanced functionality. Follow step-by-step instructions to obtain Groq API credentials, configure Jan settings, enable Groq integration, and troubleshoot any issues."/>
</head>
## 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.

12
docs/docs/guides/integration/lmstudio.mdx
View File

@ -16,6 +16,18 @@ keywords:
]
---
<head>
<title>LM Studio</title>
<meta name="description" content="A step-by-step guide on how to integrate Jan with LM Studio. Learn how to connect Jan to LM Studio, set up LM Studio server, configure Jan settings, enable LM Studio integration, migrate models, and troubleshoot integration issues."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, LM Studio integration"/>
<meta property="og:title" content="LM Studio"/>
<meta property="og:description" content="A step-by-step guide on how to integrate Jan with LM Studio. Learn how to connect Jan to LM Studio, set up LM Studio server, configure Jan settings, enable LM Studio integration, migrate models, and troubleshoot integration issues."/>
<meta property="og:url" content="https://jan.ai/guides/integration/lm-studio"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="LM Studio"/>
<meta name="twitter:description" content="A step-by-step guide on how to integrate Jan with LM Studio. Learn how to connect Jan to LM Studio, set up LM Studio server, configure Jan settings, enable LM Studio integration, migrate models, and troubleshoot integration issues."/>
</head>
## 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:

12
docs/docs/guides/integration/mistral.mdx
View File

@ -16,6 +16,18 @@ keywords:
]
---
<head>
<title>Mistral AI</title>
<meta name="description" content="A step-by-step guide on how to integrate Jan with Mistral AI. Learn how to configure Mistral API keys, set up model configuration, and start the model in Jan for enhanced functionality."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, Mistral integration"/>
<meta property="og:title" content="Mistral AI"/>
<meta property="og:description" content="A step-by-step guide on how to integrate Jan with Mistral AI. Learn how to configure Mistral API keys, set up model configuration, and start the model in Jan for enhanced functionality."/>
<meta property="og:url" content="https://jan.ai/guides/integration/mistral-ai"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Mistral AI"/>
<meta name="twitter:description" content="A step-by-step guide on how to integrate Jan with Mistral AI. Learn how to configure Mistral API keys, set up model configuration, and start the model in Jan for enhanced functionality."/>
</head>
## How to Integrate Mistral AI with Jan
[Mistral AI](https://docs.mistral.ai/) provides two ways to use their Large Language Models (LLM):

12
docs/docs/guides/integration/ollama.mdx
View File

@ -16,6 +16,18 @@ keywords:
]
---
<head>
<title>Ollama</title>
<meta name="description" content="A step-by-step guide on how to integrate Jan with Ollama. Learn how to start the Ollama server, configure model settings, and start the model in Jan for enhanced functionality."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, Ollama integration"/>
<meta property="og:title" content="Ollama"/>
<meta property="og:description" content="A step-by-step guide on how to integrate Jan with Ollama. Learn how to start the Ollama server, configure model settings, and start the model in Jan for enhanced functionality."/>
<meta property="og:url" content="https://jan.ai/guides/integration/ollama"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Ollama"/>
<meta name="twitter:description" content="A step-by-step guide on how to integrate Jan with Ollama. Learn how to start the Ollama server, configure model settings, and start the model in Jan for enhanced functionality."/>
</head>
## 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:

11
docs/docs/guides/integration/openinterpreter.mdx
View File

@ -4,6 +4,17 @@ sidebar_position: 6
description: A step-by-step guide on how to integrate Jan with Open Interpreter.
---
<head>
<title>Open Interpreter</title>
<meta name="description" content="A step-by-step guide on how to integrate Jan with Open Interpreter. Learn how to install Open Interpreter, configure Jan's local API server, and set up the Open Interpreter environment for seamless interaction with Jan."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, Open Interpreter integration"/>
<meta property="og:title" content="Open Interpreter"/>
<meta property="og:description" content="A step-by-step guide on how to integrate Jan with Open Interpreter. Learn how to install Open Interpreter, configure Jan's local API server, and set up the Open Interpreter environment for seamless interaction with Jan."/>
<meta property="og:url" content="https://jan.ai/guides/integration/open-interpreter"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Open Interpreter"/>
<meta name="twitter:description" content="A step-by-step guide on how to integrate Jan with Open Interpreter. Learn how to install Open Interpreter, configure Jan's local API server, and set up the Open Interpreter environment for seamless interaction with Jan."/>
</head>
## How to Integrate Open Interpreter with Jan

13
docs/docs/guides/integration/openrouter.mdx
View File

@ -4,6 +4,17 @@ sidebar_position: 2
description: A step-by-step guide on how to integrate Jan with OpenRouter.
---
<head>
<title>OpenRouter</title>
<meta name="description" content="A step-by-step guide on how to integrate Jan with OpenRouter. Learn how to configure the OpenRouter API key, set up model configuration, and start using remote Large Language Models (LLMs) through OpenRouter with Jan."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, OpenRouter integration"/>
<meta property="og:title" content="OpenRouter"/>
<meta property="og:description" content="A step-by-step guide on how to integrate Jan with OpenRouter. Learn how to configure the OpenRouter API key, set up model configuration, and start using remote Large Language Models (LLMs) through OpenRouter with Jan."/>
<meta property="og:url" content="https://jan.ai/guides/integration/openrouter"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="OpenRouter"/>
<meta name="twitter:description" content="A step-by-step guide on how to integrate Jan with OpenRouter. Learn how to configure the OpenRouter API key, set up model configuration, and start using remote Large Language Models (LLMs) through OpenRouter with Jan."/>
</head>
## 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`.

11
docs/docs/guides/integration/raycast.mdx
View File

@ -4,6 +4,17 @@ sidebar_position: 4
description: A step-by-step guide on how to integrate Jan with Raycast.
---
<head>
<title>Raycast</title>
<meta name="description" content="A step-by-step guide on how to integrate Jan with Raycast. Learn how to download the TinyLlama model, clone and run the program, and use Jan models in Raycast for enhanced productivity."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, Raycast integration"/>
<meta property="og:title" content="Raycast"/>
<meta property="og:description" content="A step-by-step guide on how to integrate Jan with Raycast. Learn how to download the TinyLlama model, clone and run the program, and use Jan models in Raycast for enhanced productivity."/>
<meta property="og:url" content="https://jan.ai/guides/integration/raycast"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Raycast"/>
<meta name="twitter:description" content="A step-by-step guide on how to integrate Jan with Raycast. Learn how to download the TinyLlama model, clone and run the program, and use Jan models in Raycast for enhanced productivity."/>
</head>
## 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:

12
docs/docs/guides/integration/vscode.mdx
View File

@ -17,6 +17,18 @@ keywords:
]
---
<head>
<title>Continue</title>
<meta name="description" content="A step-by-step guide on how to integrate Jan with Continue and Visual Studio Code. Learn how to install the Continue extension on Visual Studio Code, enable Jan's API server, configure Continue to use Jan's local server, and try out Jan integration with Continue in Visual Studio Code for enhanced coding experience."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, Continue integration, VSCode integration"/>
<meta property="og:title" content="Continue"/>
<meta property="og:description" content="A step-by-step guide on how to integrate Jan with Continue and Visual Studio Code. Learn how to install the Continue extension on Visual Studio Code, enable Jan's API server, configure Continue to use Jan's local server, and try out Jan integration with Continue in Visual Studio Code for enhanced coding experience."/>
<meta property="og:url" content="https://jan.ai/guides/integration/continue"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Continue"/>
<meta name="twitter:description" content="A step-by-step guide on how to integrate Jan with Continue and Visual Studio Code. Learn how to install the Continue extension on Visual Studio Code, enable Jan's API server, configure Continue to use Jan's local server, and try out Jan integration with Continue in Visual Studio Code for enhanced coding experience."/>
</head>
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

12
docs/docs/guides/models-list.mdx
View File

@ -3,6 +3,18 @@ title: Pre-configured Models
sidebar_position: 3
---
<head>
<title>Pre-configured Models - Jan Guides</title>
<meta name="description" content="Explore the various pre-configured AI models available in Jan, along with their descriptions, authors, model IDs, formats, and sizes."/>
<meta name="keywords" content="Jan AI, Jan, pre-configured models, Mistral Instruct, OpenHermes Neural, Stealth, Trinity, Openchat, Wizard Coder Python, OpenAI GPT, TinyLlama Chat, Deepseek Coder, Phi-2, Llama 2 Chat, CodeNinja, Noromaid, Starling, Yarn Mistral, LlaVa, BakLlava"/>
<meta property="og:title" content="Pre-configured Models - Jan Guides"/>
<meta property="og:description" content="Explore the various pre-configured AI models available in Jan, along with their descriptions, authors, model IDs, formats, and sizes."/>
<meta property="og:url" content="https://jan.ai/guides/pre-configured-models"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Pre-configured Models - Jan Guides"/>
<meta name="twitter:description" content="Explore the various pre-configured AI models available in Jan, along with their descriptions, authors, model IDs, formats, and sizes."/>
</head>
## Overview
Jan provides various pre-configured AI models with different capabilities. Please see the following list for details.

12
docs/docs/guides/models/customize-engine.mdx
View File

@ -17,6 +17,18 @@ keywords:
]
---
<head>
<title>Customize Engine Settings</title>
<meta name="description" content="A step-by-step guide to change your engine's settings. Learn how to modify the nitro.json file to customize parameters such as ctx_len, ngl, cpu_threads, cont_batching, and embedding to optimize the performance of your Jan AI."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, import-models-manually, customize-engine-settings"/>
<meta property="og:title" content="Customize Engine Settings"/>
<meta property="og:description" content="A step-by-step guide to change your engine's settings. Learn how to modify the nitro.json file to customize parameters such as ctx_len, ngl, cpu_threads, cont_batching, and embedding to optimize the performance of your Jan AI."/>
<meta property="og:url" content="https://jan.ai/guides/customize-engine-settings"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Customize Engine Settings"/>
<meta name="twitter:description" content="A step-by-step guide to change your engine's settings. Learn how to modify the nitro.json file to customize parameters such as ctx_len, ngl, cpu_threads, cont_batching, and embedding to optimize the performance of your Jan AI."/>
</head>
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

12
docs/docs/guides/models/import-models.mdx
View File

@ -17,6 +17,18 @@ keywords:
]
---
<head>
<title>Manual Import</title>
<meta name="description" content="A step-by-step guide on how to perform manual import feature. Learn how to import models into Jan using both drag-and-drop method and absolute file path, along with creating model folders and configuring the model JSON file."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, import-models-manually, absolute-filepath"/>
<meta property="og:title" content="Manual Import"/>
<meta property="og:description" content="A step-by-step guide on how to perform manual import feature. Learn how to import models into Jan using both drag-and-drop method and absolute file path, along with creating model folders and configuring the model JSON file."/>
<meta property="og:url" content="https://jan.ai/guides/manual-import"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Manual Import"/>
<meta name="twitter:description" content="A step-by-step guide on how to perform manual import feature. Learn how to import models into Jan using both drag-and-drop method and absolute file path, along with creating model folders and configuring the model JSON file."/>
</head>
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import janModel from './assets/jan-model-hub.png';

12
docs/docs/guides/models/integrate-remote.mdx
View File

@ -18,6 +18,18 @@ keywords:
]
---
<head>
<title>Remote Server Integration</title>
<meta name="description" content="A step-by-step guide on how to set up Jan to connect with any remote or local API server. Learn how to configure Jan as a client to connect with OpenAI Platform or any OpenAI-compatible endpoint, and how to start models using Jan's Hub."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, import-models-manually, remote server, OAI compatible"/>
<meta property="og:title" content="Remote Server Integration"/>
<meta property="og:description" content="A step-by-step guide on how to set up Jan to connect with any remote or local API server. Learn how to configure Jan as a client to connect with OpenAI Platform or any OpenAI-compatible endpoint, and how to start models using Jan's Hub."/>
<meta property="og:url" content="https://jan.ai/guides/remote-server-integration"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Remote Server Integration"/>
<meta name="twitter:description" content="A step-by-step guide on how to set up Jan to connect with any remote or local API server. Learn how to configure Jan as a client to connect with OpenAI Platform or any OpenAI-compatible endpoint, and how to start models using Jan's Hub."/>
</head>
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

14
docs/docs/guides/providers/llama-cpp.md
View File

@ -3,8 +3,20 @@ title: llama.cpp
slug: /guides/providers/llama-cpp
---
<head>
<title>llama.cpp - Jan Guides</title>
<meta name="description" content="Learn about llama.cpp, the inference server used by Nitro, the default AI engine downloaded with Jan. Understand how Nitro provides an OpenAI-compatible API, queue, & scaling."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, llama.cpp, Nitro, inference server, OpenAI-compatible API, queue, scaling"/>
<meta property="og:title" content="llama.cpp - Jan Guides"/>
<meta property="og:description" content="Learn about llama.cpp, the inference server used by Nitro, the default AI engine downloaded with Jan. Understand how Nitro provides an OpenAI-compatible API, queue, & scaling."/>
<meta property="og:url" content="https://jan.ai/guides/providers/llama-cpp"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="llama.cpp - Jan Guides"/>
<meta name="twitter:description" content="Learn about llama.cpp, the inference server used by Nitro, the default AI engine downloaded with Jan. Understand how Nitro provides an OpenAI-compatible API, queue, & scaling."/>
</head>
## 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.
Nitro is the default AI engine downloaded with Jan. There is no additional setup needed.

19
docs/docs/guides/providers/tensorrt-llm.md
View File

@ -3,11 +3,23 @@ title: TensorRT-LLM
slug: /guides/providers/tensorrt-llm
---
<head>
<title>TensorRT-LLM - Jan Guides</title>
<meta name="description" content="Learn how to install Jan's official TensorRT-LLM Extension, which offers 20-40% faster token speeds on Nvidia GPUs. Understand the requirements, installation steps, and troubleshooting tips."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, TensorRT-LLM, Nvidia GPU, TensorRT, extension, installation, troubleshooting"/>
<meta property="og:title" content="TensorRT-LLM - Jan Guides"/>
<meta property="og:description" content="Learn how to install Jan's official TensorRT-LLM Extension, which offers 20-40% faster token speeds on Nvidia GPUs. Understand the requirements, installation steps, and troubleshooting tips."/>
<meta property="og:url" content="https://jan.ai/guides/providers/tensorrt-llm"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="TensorRT-LLM - Jan Guides"/>
<meta name="twitter:description" content="Learn how to install Jan's official TensorRT-LLM Extension, which offers 20-40% faster token speeds on Nvidia GPUs. Understand the requirements, installation steps, and troubleshooting tips."/>
</head>
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

12
docs/docs/guides/quickstart.mdx
View File

@ -16,6 +16,18 @@ keywords:
]
---
<head>
<title>Quickstart - Jan Docs</title>
<meta name="description" content="Get started quickly with Jan, a ChatGPT-alternative that runs on your own computer, with a local API server. Learn how to install Jan and select an AI model to start chatting."/>
<meta name="keywords" content="Jan AI, Jan, Quickstart, installation, select AI model, using AI model, getting started"/>
<meta property="og:title" content="Quickstart - Jan Docs"/>
<meta property="og:description" content="Get started quickly with Jan, a ChatGPT-alternative that runs on your own computer, with a local API server. Learn how to install Jan and select an AI model to start chatting."/>
<meta property="og:url" content="https://jan.ai/guides"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Quickstart - Jan Docs"/>
<meta name="twitter:description" content="Get started quickly with Jan, a ChatGPT-alternative that runs on your own computer, with a local API server. Learn how to install Jan and select an AI model to start chatting."/>
</head>
import installImageURL from './assets/jan-ai-quickstart.png';
import flow from './assets/quick.png';

11
docs/docs/guides/start-server.mdx
View File

@ -4,6 +4,17 @@ sidebar_position: 4
description: A step-by-step guide to start Jan Local Server.
---
<head>
<title>Local Server - Jan Docs</title>
<meta name="description" content="A step-by-step guide to start Jan Local Server, including setting up the server and making requests to the local server. Learn how to configure server settings and start using the built-in API server."/>
<meta name="keywords" content="Jan AI, Jan, Local Server, API server, built-in server, start server, configure server settings, make requests"/>
<meta property="og:title" content="Local Server - Jan Docs"/>
<meta property="og:description" content="A step-by-step guide to start Jan Local Server, including setting up the server and making requests to the local server. Learn how to configure server settings and start using the built-in API server."/>
<meta property="og:url" content="https://jan.ai/guides/local-server"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Local Server - Jan Docs"/>
<meta name="twitter:description" content="A step-by-step guide to start Jan Local Server, including setting up the server and making requests to the local server. Learn how to configure server settings and start using the built-in API server."/>
</head>
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.

11
docs/docs/guides/thread.mdx
View File

@ -5,6 +5,17 @@ hide_table_of_contents: true
description: Manage your interaction with AI locally.
---
<head>
<title>Thread Management - Jan Docs</title>
<meta name="description" content="Learn how to manage your interaction with AI locally using Jan, including viewing thread history, managing threads via the Jan data folder, cleaning thread history, and deleting thread history."/>
<meta name="keywords" content="Jan AI, Jan, Thread Management, AI interaction, local AI, manage threads, view thread history, clean thread history, delete thread history"/>
<meta property="og:title" content="Thread Management - Jan Docs"/>
<meta property="og:description" content="Learn how to manage your interaction with AI locally using Jan, including viewing thread history, managing threads via the Jan data folder, cleaning thread history, and deleting thread history."/>
<meta property="og:url" content="https://jan.ai/guides/thread-management"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Thread Management - Jan Docs"/>
<meta name="twitter:description" content="Learn how to manage your interaction with AI locally using Jan, including viewing thread history, managing threads via the Jan data folder, cleaning thread history, and deleting thread history."/>
</head>
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.

33
docs/docs/hardware/community.md
View File

@ -1,12 +1,36 @@
---
title: Hardware Examples
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ]
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
local AI,
private AI,
conversational AI,
no-subscription fee,
large language model,
]
---
<head>
<title>Hardware Examples</title>
<meta charset="utf-8" />
<meta name="description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. Add your own hardware examples to this page by creating a new file in the `docs/docs/hardware/examples` directory." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/guides/hardware-examples" />
<meta property="og:title" content="Hardware Examples" />
<meta property="og:description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. Add your own hardware examples to this page by creating a new file in the `docs/docs/hardware/examples` directory." />
<meta property="og:url" content="https://jan.ai/guides/hardware-examples" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-hardware-examples.png" />
</head>
## Add your own example
Add your own examples to this page by creating a new file in the `docs/docs/hardware/examples` directory.
Add your own examples to this page by creating a new file in the `docs/docs/hardware/examples` directory.
```shell
docs
@ -18,9 +42,10 @@ docs
// highlight-next-line
└── <YOUR_BUILD_HERE>.md
```
### File and Title Convention
We use a specific naming convention for the file name.
We use a specific naming convention for the file name.
```shell
# Filename
@ -52,4 +77,4 @@ You are allowed to include affiliate links in your example.
## Longer-Term
We will likely build a simple web app to make it easier to add your own examples, sort and retrieve.
We will likely build a simple web app to make it easier to add your own examples, sort and retrieve.

14
docs/docs/hardware/concepts/gpu-and-vram.md
View File

@ -2,6 +2,20 @@
title: GPUs and VRAM
---
<head>
<title>Understanding GPUs and VRAM for AI and Gaming</title>
<meta charSet="utf-8" />
<meta name="description" content="Explore the world of GPUs and VRAM, learn their importance in gaming, AI, machine learning, and more. Understand how to connect a GPU to a motherboard and choose the right graphics card for your needs." />
<meta name="keywords" content="GPU, VRAM, graphics card, gaming, AI, machine learning, CUDA, NVIDIA, AMD, PCIe, VRAM vs RAM, choosing GPU" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/guides/gpus-and-vram" />
<meta property="og:title" content="Understanding GPUs and VRAM for AI and Gaming" />
<meta property="og:description" content="Explore the world of GPUs and VRAM, learn their importance in gaming, AI, machine learning, and more. Understand how to connect a GPU to a motherboard and choose the right graphics card for your needs." />
<meta property="og:url" content="https://jan.ai/guides/gpus-and-vram" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>
## 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. However, it's not just a passive piece of hardware; it's a sophisticated device equipped with essential components like fans, onboard RAM, a dedicated memory controller, BIOS, and various other features. If you want to learn more about GPUs then read here to [Understand the architecture of a GPU.](https://medium.com/codex/understanding-the-architecture-of-a-gpu-d5d2d2e8978b)

12
docs/docs/hardware/overview/cloud-vs-self-hosting.md
View File

@ -2,6 +2,18 @@
title: Cloud vs. Self-hosting Your AI
---
<head>
<title>Cloud vs. Self-hosting Your AI</title>
<meta name="description" content="Explore the pros and cons of renting AI services from the cloud versus self-hosting, including cost comparisons, business considerations, and conclusions about the best approach for different scenarios."/>
<meta name="keywords" content="Cloud AI, Self-hosted AI, AI cost comparison, AI business considerations, AI deployment, cloud vs self-hosting AI"/>
<meta property="og:title" content="Cloud vs. Self-hosting Your AI"/>
<meta property="og:description" content="Explore the pros and cons of renting AI services from the cloud versus self-hosting, including cost comparisons, business considerations, and conclusions about the best approach for different scenarios."/>
<meta property="og:url" content="https://jan.ai/articles/cloud-vs-self-hosting-your-ai"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Cloud vs. Self-hosting Your AI"/>
<meta name="twitter:description" content="Explore the pros and cons of renting AI services from the cloud versus self-hosting, including cost comparisons, business considerations, and conclusions about the best approach for different scenarios."/>
</head>
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

14
docs/docs/hardware/overview/cpu-vs-gpu.md
View File

@ -2,6 +2,20 @@
title: GPU vs CPU What's the Difference?
---
<head>
<title>GPU vs CPU What's the Difference?</title>
<meta name="description" content="Explore the differences between CPU and GPU in terms of function, processing, design, and best-suited applications."/>
<meta name="keywords" content="CPU, GPU, CPU vs GPU, Central Processing Unit, Graphics Processing Unit, CPU vs GPU differences"/>
<meta property="og:title" content="GPU vs CPU What's the Difference?"/>
<meta property="og:description" content="Explore the differences between CPU and GPU in terms of function, processing, design, and best-suited applications."/>
<meta property="og:image" content="https://media.discordapp.net/attachments/964896173401976932/1157998193741660222/CPU-vs-GPU-rendering.png?ex=651aa55b&is=651953db&hm=a22c80ed108a0d25106a20aa25236f7d0fa74167a50788194470f57ce7f4a6ca&=&width=807&height=426"/>
<meta property="og:url" content="https://jan.ai/articles/gpu-vs-cpu-differences"/>
<meta name="twitter:card" content="summary_large_image"/>
<meta name="twitter:title" content="GPU vs CPU What's the Difference?"/>
<meta name="twitter:description" content="Explore the differences between CPU and GPU in terms of function, processing, design, and best-suited applications."/>
<meta name="twitter:image" content="https://media.discordapp.net/attachments/964896173401976932/1157998193741660222/CPU-vs-GPU-rendering.png?ex=651aa55b&is=651953db&hm=a22c80ed108a0d25106a20aa25236f7d0fa74167a50788194470f57ce7f4a6ca&=&width=807&height=426"/>
</head>
## CPU vs. GPU
| | CPU | GPU |

14
docs/docs/hardware/recommendations/by-budget.md
View File

@ -2,6 +2,20 @@
title: Recommended AI Hardware by Budget
---
<head>
<title>Recommended AI Hardware Builds by Budget</title>
<meta charSet="utf-8" />
<meta name="description" content="Explore recommended AI hardware builds for entry-level, mid-range, and high-end budgets. Find the perfect balance of performance and cost for your AI and machine learning projects." />
<meta name="keywords" content="AI hardware, budget PC build, entry-level AI PC, mid-range AI PC, high-end AI PC, GPU for AI, AI PC build, machine learning hardware" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/guides/recommended-ai-hardware-by-budget" />
<meta property="og:title" content="Recommended AI Hardware Builds by Budget" />
<meta property="og:description" content="Explore recommended AI hardware builds for entry-level, mid-range, and high-end budgets. Find the perfect balance of performance and cost for your AI and machine learning projects." />
<meta property="og:url" content="https://jan.ai/guides/recommended-ai-hardware-by-budget" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>
> :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

14
docs/docs/hardware/recommendations/by-hardware.md
View File

@ -2,6 +2,20 @@
title: Selecting AI Hardware
---
<head>
<title>Selecting AI Hardware</title>
<meta charset="utf-8" />
<meta name="description" content="Guidance on selecting optimal AI hardware, including GPUs, CPUs, RAM, and motherboards for running Large Language Models (LLMs) efficiently. Explore factors like VRAM, CUDA compatibility, and unified memory architecture to build a powerful AI setup." />
<meta name="keywords" content="AI hardware, GPU for LLM, CPU for AI, RAM for machine learning, motherboard for AI, CUDA, VRAM, Unified Memory Architecture, M1, M2 Pro/Max, VRAM calculation" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/guides/selecting-ai-hardware" />
<meta property="og:title" content="Selecting AI Hardware" />
<meta property="og:description" content="Guidance on selecting optimal AI hardware, including GPUs, CPUs, RAM, and motherboards for running Large Language Models (LLMs) efficiently. Explore factors like VRAM, CUDA compatibility, and unified memory architecture to build a powerful AI setup." />
<meta property="og:url" content="https://jan.ai/guides/selecting-ai-hardware" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-ai-hardware.png" />
</head>
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.

14
docs/docs/hardware/recommendations/by-model.md
View File

@ -2,6 +2,20 @@
title: Recommended AI Hardware by Model
---
<head>
<title>Recommended AI Hardware by Model</title>
<meta charset="utf-8" />
<meta name="description" content="Explore the recommended AI hardware specifications for running Codellama models efficiently. Find RAM and VRAM requirements for different parameter sizes and quantization formats, along with minimum recommended GPUs." />
<meta name="keywords" content="Codellama, AI hardware, recommended hardware, system requirements, RAM requirements, VRAM requirements, GPU recommendations, GPTQ, GGML, GGUF, parameter models, quantization formats" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/recommended-ai-hardware-by-model" />
<meta property="og:title" content="Recommended AI Hardware by Model" />
<meta property="og:description" content="Explore the recommended AI hardware specifications for running Codellama models efficiently. Find RAM and VRAM requirements for different parameter sizes and quantization formats, along with minimum recommended GPUs." />
<meta property="og:url" content="https://jan.ai/recommended-ai-hardware-by-model" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-recommended-hardware.png" />
</head>
## Codellama 34b
### System Requirements:

14
docs/docs/hardware/recommendations/by-usecase.md
View File

@ -2,6 +2,20 @@
title: Recommended AI Hardware by Use Case
---
<head>
<title>Recommended AI Hardware by Model</title>
<meta charset="utf-8" />
<meta name="description" content="Explore hardware requirements for running Codellama 34b models effectively. Find system, RAM, and VRAM requirements along with GPU recommendations tailored for optimal performance or budget-friendly setups." />
<meta name="keywords" content="AI hardware, Codellama 34b, system requirements, RAM requirements, VRAM requirements, GPU recommendations, optimal performance, budget-friendly setup" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/guides/recommended-ai-hardware-by-model" />
<meta property="og:title" content="Recommended AI Hardware by Model" />
<meta property="og:description" content="Explore hardware requirements for running Codellama 34b models effectively. Find system, RAM, and VRAM requirements along with GPU recommendations tailored for optimal performance or budget-friendly setups." />
<meta property="og:url" content="https://jan.ai/guides/recommended-ai-hardware-by-model" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-ai-hardware-model.png" />
</head>
## 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 performance and results. Here are some tips for selecting AI hardware based on your specific use case and requirements.

12
docs/docs/how-we-work.md
View File

@ -2,6 +2,18 @@
title: How We Work
---
<head>
<title>How We Work - Jan</title>
<meta name="description" content="Learn about how Jan operates as an open-source startup, building in public, with a remote team. Explore Jan's GitHub repositories, Kanban board, and roadmap."/>
<meta name="keywords" content="Jan AI, Jan, open source, build in public, GitHub, remote team, Discord, roadmap, Kanban"/>
<meta property="og:title" content="How We Work - Jan"/>
<meta property="og:description" content="Learn about how Jan operates as an open-source startup, building in public, with a remote team. Explore Jan's GitHub repositories, Kanban board, and roadmap."/>
<meta property="og:url" content="https://jan.ai/how-we-work"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="How We Work - Jan"/>
<meta name="twitter:description" content="Learn about how Jan operates as an open-source startup, building in public, with a remote team. Explore Jan's GitHub repositories, Kanban board, and roadmap."/>
</head>
### 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.

12
docs/docs/how-we-work/analytics/analytics.md
View File

@ -2,6 +2,18 @@
title: Analytics
---
<head>
<title>Analytics</title>
<meta name="description" content="Learn about the analytics philosophy for Jan, focusing on privacy preservation and collecting minimal data for essential functionality."/>
<meta name="keywords" content="analytics, privacy-preserving, Umami, data collection, GDPR compliance"/>
<meta property="og:title" content="Analytics"/>
<meta property="og:description" content="Learn about the analytics philosophy for Jan, focusing on privacy preservation and collecting minimal data for essential functionality."/>
<meta property="og:url" content="https://jan.ai/analytics"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Analytics"/>
<meta name="twitter:description" content="Learn about the analytics philosophy for Jan, focusing on privacy preservation and collecting minimal data for essential functionality."/>
</head>
Adhering to Jan's privacy preserving philosophy, our analytics philosophy is to get "barely-enough-to-function'.
#### What is tracked

12
docs/docs/how-we-work/engineering/qa.mdx
View File

@ -15,6 +15,18 @@ keywords:
]
---
<head>
<title>QA</title>
<meta name="description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. Learn about the QA process for engineering and development phases."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, QA, quality assurance, engineering, development"/>
<meta property="og:title" content="QA"/>
<meta property="og:description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. Learn about the QA process for engineering and development phases."/>
<meta property="og:url" content="https://jan.ai/engineering/qa"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="QA"/>
<meta name="twitter:description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. Learn about the QA process for engineering and development phases."/>
</head>
### Phase 1: Planning
#### Definition of Ready (DoR):

13
docs/docs/how-we-work/project-management/project-management.md
View File

@ -2,6 +2,18 @@
title: Project Management
---
<head>
<title>Project Management</title>
<meta name="description" content="Learn about Jan's project management approach, including roadmap management, organization of epics and tasks, and Kanban board usage."/>
<meta name="keywords" content="Jan AI, project management, roadmap, epics, tasks, Kanban board"/>
<meta property="og:title" content="Project Management"/>
<meta property="og:description" content="Learn about Jan's project management approach, including roadmap management, organization of epics and tasks, and Kanban board usage."/>
<meta property="og:url" content="https://jan.ai/project-management"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Project Management"/>
<meta name="twitter:description" content="Learn about Jan's project management approach, including roadmap management, organization of epics and tasks, and Kanban board usage."/>
</head>
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.

14
docs/docs/how-we-work/strategy/strategy.md
View File

@ -2,7 +2,20 @@
title: Strategy
---
<head>
<title>Strategy</title>
<meta name="description" content="Learn about Jan's strategy, ideal customer, problems it solves, and solutions provided."/>
<meta name="keywords" content="Jan AI, Jan, AI enthusiast, business, open source alternatives, control, stability, privacy, customisability"/>
<meta property="og:title" content="Strategy"/>
<meta property="og:description" content="Learn about Jan's strategy, ideal customer, problems it solves, and solutions provided."/>
<meta property="og:url" content="https://jan.ai/strategy"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Strategy"/>
<meta name="twitter:description" content="Learn about Jan's strategy, ideal customer, problems it solves, and solutions provided."/>
</head>
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)

12
docs/docs/how-we-work/website-docs/website-docs.md
View File

@ -2,6 +2,18 @@
title: Website & Docs
---
<head>
<title>Website & Docs</title>
<meta name="description" content="Learn about the website architecture and documentation structure for Jan, including information on how to contribute, prerequisites, installation, deployment, and additional plugins."/>
<meta name="keywords" content="Jan AI, website, documentation, Docusaurus, contribution guide, installation, deployment, plugins"/>
<meta property="og:title" content="Website & Docs"/>
<meta property="og:description" content="Learn about the website architecture and documentation structure for Jan, including information on how to contribute, prerequisites, installation, deployment, and additional plugins."/>
<meta property="og:url" content="https://jan.ai/website-docs"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Website & Docs"/>
<meta name="twitter:description" content="Learn about the website architecture and documentation structure for Jan, including information on how to contribute, prerequisites, installation, deployment, and additional plugins."/>
</head>
This website is built using [Docusaurus 3.0](https://docusaurus.io/), a modern static website generator.
### Information Architecture

12
docs/docs/platforms/desktop.md
View File

@ -15,6 +15,18 @@ keywords:
]
---
<head>
<title>Jan Desktop</title>
<meta name="description" content="Turn any computer into an AI computer with Jan Desktop. Run AI models directly on your laptop without an internet connection. Enjoy private conversations and customize your AI experience."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, desktop app, AI models, offline AI"/>
<meta property="og:title" content="Jan Desktop"/>
<meta property="og:description" content="Turn any computer into an AI computer with Jan Desktop. Run AI models directly on your laptop without an internet connection. Enjoy private conversations and customize your AI experience."/>
<meta property="og:url" content="https://jan.ai/desktop"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Jan Desktop"/>
<meta name="twitter:description" content="Turn any computer into an AI computer with Jan Desktop. Run AI models directly on your laptop without an internet connection. Enjoy private conversations and customize your AI experience."/>
</head>
# Turn any computer into an AI computer
![Alt text](image.png)

18
docs/docs/privacy/privacy.md
View File

@ -1,3 +1,21 @@
---
title: Privacy - Jan
---
<head>
<title>Privacy Policy - Jan</title>
<meta charset="utf-8" />
<meta name="description" content="Learn about Jan's commitment to privacy and how your personal information is handled when using our mobile application. Understand our data collection, sharing, and security measures." />
<meta name="keywords" content="Jan AI, Jan, privacy policy, data collection, data usage, data sharing, data security, user choices, contact us" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/privacy-policy" />
<meta property="og:title" content="Privacy Policy - Jan" />
<meta property="og:description" content="Learn about Jan's commitment to privacy and how your personal information is handled when using our mobile application. Understand our data collection, sharing, and security measures." />
<meta property="og:url" content="https://jan.ai/privacy-policy" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-privacy-policy.png" />
</head>
# 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.

12
docs/docs/server-suite/enterprise.md
View File

@ -15,6 +15,18 @@ keywords:
]
---
<head>
<title>Jan Enterprise</title>
<meta name="description" content="Jan Enterprise is built for enterprise deployments, allowing organizations to customize and run AI at scale across their infrastructure. Own your AI, data, and IP with Jan Enterprise."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, enterprise AI, on-prem AI, datacenter AI"/>
<meta property="og:title" content="Jan Enterprise"/>
<meta property="og:description" content="Jan Enterprise is built for enterprise deployments, allowing organizations to customize and run AI at scale across their infrastructure. Own your AI, data, and IP with Jan Enterprise."/>
<meta property="og:url" content="https://jan.ai/enterprise"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Jan Enterprise"/>
<meta name="twitter:description" content="Jan Enterprise is built for enterprise deployments, allowing organizations to customize and run AI at scale across their infrastructure. Own your AI, data, and IP with Jan Enterprise."/>
</head>
# Customize and run AI across your organization
Jan can professional backend to create, customize and run AIs at scale, for production-grade data centers.

12
docs/docs/server-suite/home-server.md
View File

@ -15,6 +15,18 @@ keywords:
]
---
<head>
<title>Jan Home Server</title>
<meta name="description" content="Jan Home Server is built for home server deployments, allowing individuals to customize and run AI across all their devices. Self-host Jan, access it from anywhere, and collaborate with others using Jan Server Suite."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, home server, self-hosted AI, personal AI"/>
<meta property="og:title" content="Jan Home Server"/>
<meta property="og:description" content="Jan Home Server is built for home server deployments, allowing individuals to customize and run AI across all their devices. Self-host Jan, access it from anywhere, and collaborate with others using Jan Server Suite."/>
<meta property="og:url" content="https://jan.ai/home-server"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Jan Home Server"/>
<meta name="twitter:description" content="Jan Home Server is built for home server deployments, allowing individuals to customize and run AI across all their devices. Self-host Jan, access it from anywhere, and collaborate with others using Jan Server Suite."/>
</head>
# Customize and run AI across all of your devices
Self-host and access your AI from anywhere with Jan server suite.

18
docs/docs/support/support.md
View File

@ -1,3 +1,21 @@
---
title: Support - Jan
---
<head>
<title>Support - Jan</title>
<meta charset="utf-8" />
<meta name="description" content="Find support options for Jan, including bug reporting, discussion forums, business inquiries, and job applications. Connect with us through GitHub, Discord, or email." />
<meta name="keywords" content="Jan AI, Jan, support, bug reporting, GitHub, Discord, business inquiries, job applications, contact us" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/support" />
<meta property="og:title" content="Support - Jan" />
<meta property="og:description" content="Find support options for Jan, including bug reporting, discussion forums, business inquiries, and job applications. Connect with us through GitHub, Discord, or email." />
<meta property="og:url" content="https://jan.ai/support" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-support.png" />
</head>
# Support
- Bugs & requests: file a GitHub ticket [here](https://github.com/janhq/jan/issues)

15
docs/docs/team/team.md
View File

@ -2,6 +2,18 @@
title: Who we are
---
<head>
<title>Who we are - Jan</title>
<meta name="description" content="Learn about Jan, a company aiming to build the cognitive framework for future robots. We are an open source startup with a commitment to the open source AI ecosystem. Jan is currently a bootstrapped startup seeking a sustainable business model. Join us on our journey to find product-market fit."/>
<meta name="keywords" content="Jan AI, Jan, open source, startup, cognitive framework, future robots, bootstrapped, PMF, sustainable business model"/>
<meta property="og:title" content="Who we are - Jan"/>
<meta property="og:description" content="Learn about Jan, a company aiming to build the cognitive framework for future robots. We are an open source startup with a commitment to the open source AI ecosystem. Jan is currently a bootstrapped startup seeking a sustainable business model. Join us on our journey to find product-market fit."/>
<meta property="og:url" content="https://jan.ai/who-we-are"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Who we are - Jan"/>
<meta name="twitter:description" content="Learn about Jan, a company aiming to build the cognitive framework for future robots. We are an open source startup with a commitment to the open source AI ecosystem. Jan is currently a bootstrapped startup seeking a sustainable business model. Join us on our journey to find product-market fit."/>
</head>
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
- Core Team

13
docs/docs/template/QA_script.md vendored
View File

@ -26,7 +26,6 @@
- [ ] :key::warning: Check that the uninstallation process removes the app successfully from the system.
- [ ] Clean the Jan root directory and open the app to check if it creates all the necessary folders, especially models and extensions.
## B. Overview
### 1. Shortcut key, memory usage / CPU usage
@ -71,10 +70,12 @@
- [ ] :key: Ensure that users switch between threads with different models, the app can handle it.
### 3. Model dropdown
- [ ] :key: Model list should highlight recommended based on user RAM
- [ ] Model size should display (for both installed and imported models)
### 4. Users can click on a history thread
- [ ] Confirm that the chat window displays the entire conversation from the selected history thread without any missing messages.
- [ ] :key: Check the performance and accuracy of the history feature when dealing with a large number of threads.
- [ ] Validate that historical threads reflect the exact state of the chat at that time, including settings.
@ -82,12 +83,12 @@
- [ ] Confirm that changing the title of the thread updates correctly.
### 5. Users can config instructions for the assistant.
- [ ] Test if the instructions set by the user are being followed by the assistant in subsequent conversations.
- [ ] :key: Validate that changes to instructions are updated in real time and do not require a restart of the application or session.
- [ ] :key: Check for the ability to reset instructions to default or clear them completely.
- [ ] :key: RAG - Users can import documents and the system should process queries about the uploaded file, providing accurate and appropriate responses in the conversation thread.
## D. Hub
### 1. Users can discover recommended models (Jan ships with a few preconfigured model.json files)
@ -117,13 +118,14 @@
### 5. Users can use the model as they want
- [ ] :key: Check `start` / `stop` / `delete` button response exactly what it does.
- [ ] :key: Check `start` / `stop` / `delete` button response exactly what it does.
- [ ] Check if starting another model stops the other model entirely.
- [x] :rocket: Check the `Explore models` navigate correctly to the model panel.
- [ ] :key: Check when deleting a model it will delete all the files on the user's computer.
- [ ] :warning:The recommended tags should present right for the user's hardware.
### 6. Users can Integrate With a Remote Server
- [ ] :key: Import openAI GPT model https://jan.ai/guides/using-models/integrate-with-remote-server/ and the model displayed in Hub / Thread dropdown
- [ ] Users can use the remote model properly
@ -184,9 +186,10 @@
## G. Local API server
### 1. Local Server Usage with Server Options
- [ ] :key: Explore API Reference: Swagger API for sending/receiving requests
- [ ] Use default server option
- [ ] Configure and use custom server options
- [ ] Use default server option
- [ ] Configure and use custom server options
- [ ] Test starting/stopping the local API server with different Model/Model settings
- [ ] Server logs captured with correct Server Options provided
- [ ] Verify functionality of Open logs/Clear feature

12
docs/docs/wall-of-love.md
View File

@ -2,6 +2,18 @@
title: Wall of Love ❤️
---
<head>
<title>Wall of Love ❤️ - Jan</title>
<meta name="description" content="See what users are saying about Jan on Twitter and watch amazing videos demonstrating the use of Jan by the community. Share your love for Jan on Twitter and tag us @janframework!"/>
<meta name="keywords" content="Jan AI, Jan, testimonials, Twitter, YouTube, community, feedback, videos"/>
<meta property="og:title" content="Wall of Love ❤️ - Jan"/>
<meta property="og:description" content="See what users are saying about Jan on Twitter and watch amazing videos demonstrating the use of Jan by the community. Share your love for Jan on Twitter and tag us @janframework!"/>
<meta property="og:url" content="https://jan.ai/wall-of-love"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Wall of Love ❤️ - Jan"/>
<meta name="twitter:description" content="See what users are saying about Jan on Twitter and watch amazing videos demonstrating the use of Jan by the community. Share your love for Jan on Twitter and tag us @janframework!"/>
</head>
## Twitter
Check out our amazing users and what they are saying about Jan!

Some files were not shown because too many files have changed in this diff Show More