Update Installation pages & Jan Data Folder page

This commit is contained in:
Ashley 2025-01-03 01:44:34 +07:00
parent 57f3644269
commit d494260ae6
5 changed files with 128 additions and 38 deletions

View File

@ -29,21 +29,22 @@ This guide helps you understand where and how this data is stored.
## Open the Data Folder ## Open the Data Folder
To open the Jan data folder from the app: To open from Jan's interface:
1. Click the System monitor button on your Jan app. 1. In Jan, navigate to **Settings** > **Advanced Settings**
2. Click the App Log button. 2. Open **Jan Data Folder**
3. This redirects you to the Jan data folder.
To open through Terminal:
```bash ```bash
# Windows # Windows
~/AppData/Roaming/Jan/data %APPDATA%/Jan/data
# Mac # Mac
~/Library/Application\ Support/Jan/data ~/Library/Application Support/Jan/data
# Linux # Linux
## Custom installation directory ## Custom installation directory
$XDG_CONFIG_HOME = /home/username/custom_config $XDG_CONFIG_HOME/Jan/data
or or

View File

@ -20,9 +20,10 @@ keywords:
] ]
--- ---
import { Tabs } from 'nextra/components'
import { Callout } from 'nextra/components'
import FAQBox from '@/components/FaqBox' import FAQBox from '@/components/FaqBox'
import { Tabs, Callout, Steps } from 'nextra/components'
# Linux Installation # Linux Installation
@ -101,6 +102,8 @@ At least 10GB for app installation and model downloads.
To install Jan, follow the steps below: To install Jan, follow the steps below:
<Steps>
### Step 1: Download Application ### Step 1: Download Application
Jan provides 3 types of releases: Jan provides 3 types of releases:
@ -169,6 +172,9 @@ chmod +x jan-linux-x86_64-{version}.AppImage
</Tabs.Tab> </Tabs.Tab>
</Tabs> </Tabs>
</Steps>
## Data Folder ## Data Folder
By default, Jan is installed in the following directory: By default, Jan is installed in the following directory:
@ -192,20 +198,57 @@ Once Jan is installed and you have a GPU, you can use your GPU to accelerate the
<Tabs items={['NVIDIA GPU', 'AMD GPU', 'Intel Arc GPU']}> <Tabs items={['NVIDIA GPU', 'AMD GPU', 'Intel Arc GPU']}>
<Tabs.Tab> <Tabs.Tab>
Before enabling NVIDIA GPU support, ensure you have: <Steps>
- **CUDA Toolkit** 11.7 or higher installed
- **NVIDIA driver** version 470.63.01 or higher
### Step 1: Verify Hardware & Install Dependencies
**1.1. Check GPU Detection**
To verify that your system recognizes the NVIDIA GPU:
```
lspci | grep -i nvidia
```
**1.2. Install Required components**
**NVIDIA Driver:**
1. Install [NVIDIA Driver](https://www.nvidia.com/en-us/drivers/) for your GPU (NVIDIA driver **470.63.01 or higher**).
2. Verify installation:
```
nvidia-smi
```
Expected output should show your GPU model and driver version.
**CUDA Toolkit:**
1. Download and install [CUDA toolkit](https://developer.nvidia.com/cuda-downloads) (**CUDA 11.7 or higher**)
2. Verify installation:
```
nvcc --version
```
**Linux Additional Requirements:**
1. Required packages are installed:
```
sudo apt update
sudo apt install gcc-11 g++-11 cpp-11
```
2. Set up CUDA environment:
```
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/cuda/lib64
```
See [detailed instructions](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html#post-installation-actions).
### Step 2: Enable GPU Acceleration
1. In Jan, navigate to **Settings** > **Hardware**
3. Select and enable your prefered NVIDIA GPU(s)
4. App reload is required after the selection
To enable the use of your NVIDIA GPU in the Jan app, follow the steps below:
1. Open Jan application
2. Go to **Settings** → **Advanced Settings** → **GPU Acceleration**
3. Enable and choose the NVIDIA GPU you want
4. A success notification saying **Successfully turned on GPU acceleration** will appear when GPU acceleration is activated
<Callout type="info"> <Callout type="info">
While **Vulkan** can enable Nvidia GPU acceleration in the Jan app, **CUDA** is recommended for faster performance. While **Vulkan** can enable Nvidia GPU acceleration in the Jan app, **CUDA** is recommended for faster performance.
</Callout> </Callout>
</Steps>
</Tabs.Tab> </Tabs.Tab>
<Tabs.Tab> <Tabs.Tab>

View File

@ -21,8 +21,9 @@ keywords:
--- ---
import { Tabs } from 'nextra/components' import { Tabs } from 'nextra/components'
import { Callout } from 'nextra/components'
import FAQBox from '@/components/FaqBox' import FAQBox from '@/components/FaqBox'
import { Callout, Steps } from 'nextra/components'
# Mac Installation # Mac Installation
@ -56,6 +57,8 @@ _To verify your Mac's processor architecture: Apple menu  → About This Mac.
To install Jan, follow the steps below: To install Jan, follow the steps below:
<Steps>
### Step 1: Download Application ### Step 1: Download Application
Jan provides 3 types of releases: Jan provides 3 types of releases:
@ -97,6 +100,8 @@ Keep in mind that this build crashes frequently or contains bugs!
3. Installation will take a few moments to complete 3. Installation will take a few moments to complete
4. Launch Jan from your Applications folder 4. Launch Jan from your Applications folder
</Steps>
## Jan Data Folder ## Jan Data Folder
@ -110,7 +115,10 @@ See [Jan Data Folder](/docs/data-folder) for more details about the data folder
## Uninstall Jan ## Uninstall Jan
### Remove Application
<Steps>
### Step 1: Remove Application
1. If Jan is currently open, exit the app 1. If Jan is currently open, exit the app
2. Open **Finder** menu. 2. Open **Finder** menu.
3. Navigate to **Applications** 3. Navigate to **Applications**
@ -120,7 +128,8 @@ See [Jan Data Folder](/docs/data-folder) for more details about the data folder
- Right-click → **Move to Trash** - Right-click → **Move to Trash**
- Select and press **Command-Delete** - Select and press **Command-Delete**
### Clean Up Data (Optional) ### Step 2: Clean Up Data (Optional)
Open **Terminal** and run these commands to remove all Jan-related data: Open **Terminal** and run these commands to remove all Jan-related data:
```bash ```bash
@ -133,6 +142,8 @@ rm -rf ~/Library/Application\ Support/Jan/data
# Delete application cache # Delete application cache
rm -rf ~/Library/Application\ Support/Jan/cache rm -rf ~/Library/Application\ Support/Jan/cache
``` ```
</Steps>
<Callout type="warning"> <Callout type="warning">
Deleted data folders cannot be restored. Make sure to backup any important data before proceeding with deletion. Deleted data folders cannot be restored. Make sure to backup any important data before proceeding with deletion.
</Callout> </Callout>

View File

@ -43,16 +43,16 @@ Ensure that your system meets the following requirements to use Jan effectively:
Jan requires a processor with AVX2 for best performance. See [full list of supported processors.](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions#CPUs_with_AVX2) While older processors with AVX/AVX-512 will work, you may experience slower performance. Jan requires a processor with AVX2 for best performance. See [full list of supported processors.](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions#CPUs_with_AVX2) While older processors with AVX/AVX-512 will work, you may experience slower performance.
</Callout> </Callout>
- **Memory (RAM)** - **Memory (RAM)**
- 8GB 3B parameter models (int4) - 8GB > 3B parameter models (int4)
- 16GB 7B parameter models (int4) - 16GB > 7B parameter models (int4)
- 32GB 13B parameter models (int4) - 32GB > 13B parameter models (int4)
<Callout type="info"> <Callout type="info">
DDR2 RAM is supported but newer RAM generations are recommended for better performance. DDR2 RAM is supported but newer RAM generations are recommended for better performance.
</Callout> </Callout>
- **GPU**: - **GPU**:
- 6GB 3B models with **ngl** at 120 (full speed) - 6GB > 3B models with **ngl** at 120 (full speed)
- 8GB 7B models with **ngl** at 120 (full speed) - 8GB > 7B models with **ngl** at 120 (full speed)
- 12GB 13B models with **ngl** at 120 (full speed) - 12GB > 13B models with **ngl** at 120 (full speed)
<Callout type="info"> <Callout type="info">
Minimum 6GB VRAM recommended for NVIDIA, AMD, or Intel Arc GPUs. Minimum 6GB VRAM recommended for NVIDIA, AMD, or Intel Arc GPUs.
</Callout> </Callout>
@ -63,6 +63,8 @@ Minimum 6GB VRAM recommended for NVIDIA, AMD, or Intel Arc GPUs.
To install Jan, follow the steps below: To install Jan, follow the steps below:
<Steps>
### Step 1: Download Application ### Step 1: Download Application
Jan provides 3 types of releases: Jan provides 3 types of releases:
@ -102,6 +104,8 @@ Keep in mind that this build crashes frequently or contains bugs!
2. Wait for Jan to be completely installed on your machine. 2. Wait for Jan to be completely installed on your machine.
3. Once installed, you can access Jan on your machine. 3. Once installed, you can access Jan on your machine.
</Steps>
## Data Folder ## Data Folder
By default, Jan is installed in the following directory: By default, Jan is installed in the following directory:
@ -121,24 +125,50 @@ Jan can leverage your GPU to significantly improve model performance and inferen
<Tabs items={['NVIDIA GPU', 'AMD GPU', 'Intel Arc GPU']}> <Tabs items={['NVIDIA GPU', 'AMD GPU', 'Intel Arc GPU']}>
<Tabs.Tab> <Tabs.Tab>
Before enabling NVIDIA GPU support, ensure you have:
- **CUDA Toolkit** 11.7 or higher installed
- **NVIDIA driver** version 470.63.01 or higher
Follow the steps below to enable the use of your NVIDIA GPU: <Steps>
1. Launch Jan
2. Navigate to **Settings** → **Advanced Settings** → Turn on **GPU Acceleration** ### Step 1: Verify Hardware & Install Dependencies
3. Select and enable your NVIDIA GPU **1.1. Check GPU Detection**
To verify that your system recognizes the NVIDIA GPU:
- Right-click desktop > NVIDIA Control Panel
- Or check Device Manager > Display Adapters
**1.2. Install Required components**
**NVIDIA Driver:**
1. Install [NVIDIA Driver](https://www.nvidia.com/en-us/drivers/) for your GPU (NVIDIA driver **470.63.01 or higher**).
2. Verify installation:
```
nvidia-smi
```
Expected output should show your GPU model and driver version.
**CUDA Toolkit:**
1. Download and install [CUDA toolkit](https://developer.nvidia.com/cuda-downloads) (**CUDA 11.7 or higher**)
2. Verify installation:
```
nvcc --version
```
### Step 2: Enable GPU Acceleration
1. In Jan, navigate to **Settings** > **Hardware**
3. Select and enable your prefered NVIDIA GPU(s)
4. App reload is required after the selection 4. App reload is required after the selection
<Callout type="info"> <Callout type="info">
While Jan supports both CUDA and Vulkan for NVIDIA GPUs, we strongly recommend using CUDA for optimal performance. While Jan supports both CUDA and Vulkan for NVIDIA GPUs, we strongly recommend using CUDA for optimal performance.
</Callout> </Callout>
</Steps>
</Tabs.Tab> </Tabs.Tab>
<Tabs.Tab> <Tabs.Tab>
AMD GPUs require **Vulkan** support, which must be activated through **Experimental Mode**. AMD GPUs require **Vulkan** support, which must be activated through **Experimental Mode**.
1. Launch Jan 1. Launch Jan
2. Navigate to **Settings** → **Advanced Settings** 2. Navigate to **Settings** > **Advanced Settings**
3. Enable **Experimental Mode** 3. Enable **Experimental Mode**
4. Under **GPU Acceleration**, enable **Vulkan Support** 4. Under **GPU Acceleration**, enable **Vulkan Support**
5. Enable **GPU Acceleration** and select your AMD GPU 5. Enable **GPU Acceleration** and select your AMD GPU
@ -148,7 +178,7 @@ AMD GPUs require **Vulkan** support, which must be activated through **Experimen
<Tabs.Tab> <Tabs.Tab>
Intel Arc GPUs require **Vulkan** support, which must be activated through **Experimental Mode**. Intel Arc GPUs require **Vulkan** support, which must be activated through **Experimental Mode**.
1. Launch Jan 1. Launch Jan
2. Navigate to **Settings** **Advanced Settings** 2. Navigate to **Settings** > **Advanced Settings**
3. Enable **Experimental Mode** 3. Enable **Experimental Mode**
4. Under **GPU Acceleration**, enable **Vulkan Support** 4. Under **GPU Acceleration**, enable **Vulkan Support**
5. Enable **GPU Acceleration** and select your Intel Arc GPU 5. Enable **GPU Acceleration** and select your Intel Arc GPU
@ -161,13 +191,15 @@ Intel Arc GPUs require **Vulkan** support, which must be activated through **Exp
## Uninstall Jan ## Uninstall Jan
<Steps>
### Step 1: Remove Application through Control Panel ### Step 1: Remove Application through Control Panel
1. Open **Control Panels** 1. Open **Control Panels**
2. Go to **Programs** section 2. Go to **Programs** section
3. Click **Uninstall Program** 3. Click **Uninstall Program**
4. Search for **Jan** 4. Search for **Jan**
5. Click the **three dots icon → Uninstall** 5. Click the **Three Dots Icon** > **Uninstall**
6. Click **Uninstall** again to confirm 6. Click **Uninstall** again to confirm
7. Click **OK** 7. Click **OK**
@ -183,10 +215,13 @@ To ensure a complete uninstallation, remove the app cache:
1. Navigate to `C:\Users\[username]\AppData\Roaming` 1. Navigate to `C:\Users\[username]\AppData\Roaming`
2. Delete Jan folder 2. Delete Jan folder
</Steps>
<Callout type="warning"> <Callout type="warning">
Deleted data folders cannot be restored. Make sure to backup any important data before proceeding with deletion. Deleted data folders cannot be restored. Make sure to backup any important data before proceeding with deletion.
</Callout> </Callout>
{/* ## FAQs {/* ## FAQs
<FAQBox title="What are Nightly Releases, and how can I access them?"> <FAQBox title="What are Nightly Releases, and how can I access them?">

View File

@ -161,7 +161,7 @@ lspci | grep -i nvidia
``` ```
#### 1.2. Install Required components #### 1.2. Install Required components
**NVIDIA Driver:** **NVIDIA Driver:**
1. Install [NVIDIA Driver](https://www.nvidia.com/en-us/drivers/) for your GPU (CUDA 11.7 or higher) 1. Install [NVIDIA Driver](https://www.nvidia.com/en-us/drivers/) for your GPU (NVIDIA driver **470.63.01 or higher**).
2. Verify installation: 2. Verify installation:
``` ```
@ -170,7 +170,7 @@ nvidia-smi
Expected output should show your GPU model and driver version. Expected output should show your GPU model and driver version.
**CUDA Toolkit:** **CUDA Toolkit:**
1. Download and install [CUDA toolkit](https://developer.nvidia.com/cuda-downloads) 1. Download and install [CUDA toolkit](https://developer.nvidia.com/cuda-downloads) (**CUDA 11.7 or higher**)
2. Verify installation: 2. Verify installation:
``` ```