[WIP] updating docs...
This commit is contained in:
parent
d0c21ee506
commit
42353d940f
@ -28,13 +28,15 @@ import FAQBox from '@/components/FaqBox'
|
|||||||
# Linux Installation
|
# Linux Installation
|
||||||
To install Jan desktop on Linux, follow the steps below:
|
To install Jan desktop on Linux, follow the steps below:
|
||||||
## Compatibility
|
## Compatibility
|
||||||
|
|
||||||
Ensure that your system meets the following requirements to use Jan effectively:
|
Ensure that your system meets the following requirements to use Jan effectively:
|
||||||
|
|
||||||
<Tabs items={['OS', 'CPU', 'RAM', 'GPU', 'Disk']}>
|
<Tabs items={['OS', 'CPU', 'RAM', 'GPU', 'Disk']}>
|
||||||
|
|
||||||
<Tabs.Tab>
|
<Tabs.Tab>
|
||||||
- Debian-based (Supports `.deb` and `AppImage` )
|
#### Debian-based (Supports `.deb` and `AppImage`)
|
||||||
- Ubuntu-based
|
- Debian
|
||||||
- Ubuntu Desktop LTS (official)/ Ubuntu Server LTS (only for server)
|
- Ubuntu and derivatives:
|
||||||
|
- Ubuntu Desktop LTS (official)/Ubuntu Server LTS (only for server)
|
||||||
- Edubuntu (Mainly desktop)
|
- Edubuntu (Mainly desktop)
|
||||||
- Kubuntu (Desktop only)
|
- Kubuntu (Desktop only)
|
||||||
- Lubuntu (Both desktop and server, though mainly desktop)
|
- Lubuntu (Both desktop and server, though mainly desktop)
|
||||||
@ -42,152 +44,131 @@ Ensure that your system meets the following requirements to use Jan effectively:
|
|||||||
- Ubuntu Cinnamon (Desktop only)
|
- Ubuntu Cinnamon (Desktop only)
|
||||||
- Ubuntu Kylin (Both desktop and server)
|
- Ubuntu Kylin (Both desktop and server)
|
||||||
- Ubuntu MATE (Desktop only)
|
- Ubuntu MATE (Desktop only)
|
||||||
- Pacman-based
|
|
||||||
- Arch Linux based
|
#### RHEL-based (Supports `.rpm` and `AppImage`)
|
||||||
- Arch Linux (Mainly desktop)
|
- RHEL-based (Server only)
|
||||||
- SteamOS (Desktop only)
|
- Fedora
|
||||||
- RPM-based (Supports `.rpm` and `AppImage` )
|
|
||||||
- Fedora-based
|
#### Arch-based
|
||||||
- RHEL-based (Server only)
|
- Arch Linux (Mainly desktop)
|
||||||
|
- SteamOS (Desktop only)
|
||||||
|
|
||||||
|
#### Independent
|
||||||
- openSUSE (Both desktop and server)
|
- openSUSE (Both desktop and server)
|
||||||
|
|
||||||
<Callout type="info">
|
<Callout type="info">
|
||||||
- Please check whether your Linux distribution supports desktop, server, or both environments.
|
Please check whether your Linux distribution supports desktop, server, or both environments.
|
||||||
|
</Callout>
|
||||||
|
</Tabs.Tab>
|
||||||
|
|
||||||
</Callout>
|
|
||||||
</Tabs.Tab>
|
|
||||||
<Tabs.Tab>
|
|
||||||
<Tabs items={['Intel', 'AMD']}>
|
|
||||||
<Tabs.Tab>
|
<Tabs.Tab>
|
||||||
|
- Haswell processors (Q2 2013) and newer
|
||||||
|
- Tiger Lake (Q3 2020) and newer for Celeron and Pentium processors
|
||||||
|
- Excavator processors (Q2 2015) and newer
|
||||||
|
|
||||||
<Callout type="info">
|
<Callout type="info">
|
||||||
- Jan supports a processor that can handle AVX2. For the full list, please see [here](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions#CPUs_with_AVX2).
|
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.
|
||||||
- We support older processors with AVX and AVX-512, though this is not recommended.
|
|
||||||
</Callout>
|
</Callout>
|
||||||
- Haswell processors (Q2 2013) and newer.
|
|
||||||
- Tiger Lake (Q3 2020) and newer for Celeron and Pentium processors.
|
|
||||||
</Tabs.Tab>
|
</Tabs.Tab>
|
||||||
|
|
||||||
<Tabs.Tab>
|
<Tabs.Tab>
|
||||||
|
- 8GB → 3B models (int4)
|
||||||
|
- 16GB → 7B models (int4)
|
||||||
|
- 32GB → 13B models (int4)
|
||||||
|
|
||||||
<Callout type="info">
|
<Callout type="info">
|
||||||
- Jan supports a processor that can handle AVX2. For the full list, please see [here](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions#CPUs_with_AVX2).
|
DDR2 RAM minimum supported, newer generations recommended for better performance.
|
||||||
- We support older processors with AVX and AVX-512, though this is not recommended.
|
|
||||||
</Callout>
|
</Callout>
|
||||||
- Excavator processors (Q2 2015) and newer.
|
|
||||||
</Tabs.Tab>
|
</Tabs.Tab>
|
||||||
|
|
||||||
|
<Tabs.Tab>
|
||||||
|
- 6GB → 3B model (int4) with `ngl` at 120
|
||||||
|
- 8GB → 7B model (int4) with `ngl` at 120
|
||||||
|
- 12GB → 13B model (int4) with `ngl` at 120
|
||||||
|
|
||||||
|
<Callout type="info">
|
||||||
|
Minimum 6GB VRAM recommended for NVIDIA, AMD, or Intel Arc GPUs.
|
||||||
|
</Callout>
|
||||||
|
</Tabs.Tab>
|
||||||
|
|
||||||
|
<Tabs.Tab>
|
||||||
|
At least 10GB for app installation and model downloads.
|
||||||
|
</Tabs.Tab>
|
||||||
|
|
||||||
</Tabs>
|
</Tabs>
|
||||||
</Tabs.Tab>
|
|
||||||
<Tabs.Tab>
|
|
||||||
- 8GB for running up to 3B models (int4).
|
|
||||||
- 16GB for running up to 7B models (int4).
|
|
||||||
- 32GB for running up to 13B models (int4).
|
|
||||||
|
|
||||||
<Callout type="info">
|
## Install Jan
|
||||||
We support DDR2 RAM as the minimum requirement but recommend using newer generations of RAM for improved performance.
|
|
||||||
|
|
||||||
</Callout>
|
|
||||||
</Tabs.Tab>
|
|
||||||
<Tabs.Tab>
|
|
||||||
- 6GB can load the 3B model (int4) with `ngl` at 120 ~ full speed on CPU/ GPU.
|
|
||||||
- 8GB can load the 7B model (int4) with `ngl` at 120 ~ full speed on CPU/ GPU.
|
|
||||||
- 12GB can load the 13B model (int4) with `ngl` at 120 ~ full speed on CPU/ GPU.
|
|
||||||
|
|
||||||
<Callout type="info">
|
|
||||||
Having at least 6GB VRAM when using NVIDIA, AMD, or Intel Arc GPUs is recommended.
|
|
||||||
|
|
||||||
</Callout>
|
|
||||||
</Tabs.Tab>
|
|
||||||
<Tabs.Tab>
|
|
||||||
- At least 10GB for app storage and model download.
|
|
||||||
</Tabs.Tab>
|
|
||||||
</Tabs>
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- **System Libraries**:
|
|
||||||
- glibc 2.27 or higher. You can verify this by running `ldd --version`.
|
|
||||||
- Install gcc-11, g++-11, cpp-11, or later versions. Refer to the [Ubuntu installation guide](https://gcc.gnu.org/projects/cxx-status.html#cxx17) for assistance.
|
|
||||||
- **Post-Installation Actions**:
|
|
||||||
- Add CUDA libraries to the `LD_LIBRARY_PATH` per the instructions in the [Post-installation Actions](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html#post-installation-actions).
|
|
||||||
|
|
||||||
## Installing Jan
|
|
||||||
|
|
||||||
To install Jan, follow the steps below:
|
To install Jan, follow the steps below:
|
||||||
|
|
||||||
### Step 1: Download the Jan Application
|
### Step 1: Download Application
|
||||||
|
|
||||||
Jan provides two types of releases:
|
Jan provides 3 types of releases:
|
||||||
<Tabs items={['Stable Releases', 'Nightly Releases']}>
|
<Tabs items={['Stable Release', 'Beta Release', 'Nightly Release']}>
|
||||||
<Tabs.Tab>
|
<Tabs.Tab>
|
||||||
#### Stable Releases
|
Please download Jan from official distributions, or build it from source.
|
||||||
|
- Download Jan on **Ubuntu**: [jan.deb](https://app.jan.ai/download/latest/linux-amd64-deb)
|
||||||
|
- Download Jan on **Fedora**: [jan.AppImage](https://app.jan.ai/download/latest/linux-amd64-appimage)
|
||||||
|
- Official Website: https://jan.ai/download
|
||||||
|
|
||||||
The stable release is a stable version of Jan. You can download a stable release Jan app via the following:
|
</Tabs.Tab>
|
||||||
|
<Tabs.Tab>
|
||||||
|
|
||||||
- **Official Website**: [https://jan.ai](https://jan.ai/)
|
Beta releases let you test new features, which may be buggy:
|
||||||
- **Jan GitHub repository**: [Github](https://github.com/janhq/jan/releases)
|
- Download Jan's Beta Version on **Ubuntu**: [jan.deb](https://app.jan.ai/download/beta/linux-amd64-deb)
|
||||||
|
- Download Jan's Beta Version on **Fedora**: [jan.AppImage](https://app.jan.ai/download/beta/linux-amd64-appimage)
|
||||||
|
|
||||||
<Callout type="info">
|
<Callout type="info">
|
||||||
Make sure to verify the URL to ensure that it's the official Jan website and GitHub repository.
|
Keep in mind that this build might crash frequently or contain bugs!
|
||||||
</Callout>
|
</Callout>
|
||||||
</Tabs.Tab>
|
</Tabs.Tab>
|
||||||
<Tabs.Tab>
|
<Tabs.Tab>
|
||||||
#### Nightly Releases
|
|
||||||
|
|
||||||
The nightly Release allows you to test out new features and get a sneak peek at what might be included in future stable releases. You can download this version via:
|
Nightly releases are for internal team to test new feature builds everyday, which is very be buggy:
|
||||||
|
|
||||||
- **Jan GitHub repository**: [Github](https://github.com/janhq/jan/actions/workflows/jan-electron-build-nightly.yml)
|
- Download Jan's Nightly Version on **Ubuntu**: [jan.deb](https://app.jan.ai/download/nightly/linux-amd64-deb)
|
||||||
|
- Download Jan's Nightly Version on **Fedora**: [jan.AppImage](https://app.jan.ai/download/nightly/linux-amd64-appimage)
|
||||||
|
|
||||||
<Callout type="info">
|
<Callout type="info">
|
||||||
Keep in mind that this build might crash frequently and may contain bugs!
|
Keep in mind that this build crashes frequently or contains bugs!
|
||||||
</Callout>
|
</Callout>
|
||||||
</Tabs.Tab>
|
</Tabs.Tab>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
For Linux, Jan provides two types of downloads:
|
|
||||||
|
|
||||||
1. **Ubuntu**: `.deb`
|
### Step 2: Install Application
|
||||||
2. **Fedora**: `.AppImage`
|
|
||||||
|
|
||||||
### Step 2: Install the Jan Application
|
|
||||||
|
|
||||||
Here are the steps to install Jan on Linux based on your Linux distribution:
|
Here are the steps to install Jan on Linux based on your Linux distribution:
|
||||||
|
|
||||||
<Tabs items={['Ubuntu', 'Fedora']}>
|
<Tabs items={['Ubuntu', 'Fedora']}>
|
||||||
<Tabs.Tab>
|
<Tabs.Tab>
|
||||||
### Ubuntu
|
Install Jan using either **dpkg** or **apt-get**:
|
||||||
Install Jan using the following command:
|
##### dpkg
|
||||||
<Tabs items={['dpkg', 'apt-get']}>
|
```bash
|
||||||
<Tabs.Tab>
|
|
||||||
|
|
||||||
```
|
|
||||||
# Install Jan using dpkg
|
# Install Jan using dpkg
|
||||||
sudo dpkg -i jan-linux-amd64-{version}.deb
|
sudo dpkg -i jan-linux-amd64-{version}.deb
|
||||||
|
|
||||||
```
|
```
|
||||||
</Tabs.Tab>
|
|
||||||
<Tabs.Tab>
|
|
||||||
|
|
||||||
```json
|
##### apt-get
|
||||||
|
```bash
|
||||||
# Install Jan using apt-get
|
# Install Jan using apt-get
|
||||||
sudo apt-get install ./jan-linux-amd64-{version}.deb
|
sudo apt-get install ./jan-linux-amd64-{version}.deb
|
||||||
# where jan-linux-amd64-{version}.deb is the path to the Jan package
|
# where jan-linux-amd64-{version}.deb is the path to the Jan package
|
||||||
```
|
```
|
||||||
</Tabs.Tab>
|
</Tabs.Tab>
|
||||||
</Tabs>
|
|
||||||
</Tabs.Tab>
|
|
||||||
<Tabs.Tab>
|
<Tabs.Tab>
|
||||||
### Fedora
|
|
||||||
|
|
||||||
1. Make the AppImage executable using the following command:
|
1. Make the AppImage executable using the following command:
|
||||||
|
```bash
|
||||||
```
|
chmod +x jan-linux-x86_64-{version}.AppImage
|
||||||
chmod +x jan-linux-x86_64-{version}.AppImage
|
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Run the AppImage file using the following command:
|
2. Run the AppImage file using the following command:
|
||||||
|
```bash
|
||||||
```
|
./jan-linux-x86_64-{version}.AppImage
|
||||||
./jan-linux-x86_64-{version}.AppImage
|
|
||||||
|
|
||||||
```
|
```
|
||||||
</Tabs.Tab>
|
</Tabs.Tab>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
## Data Folder
|
## Data Folder
|
||||||
|
|
||||||
By default, Jan is installed in the following directory:
|
By default, Jan is installed in the following directory:
|
||||||
@ -202,65 +183,60 @@ or
|
|||||||
~/.config/Jan/data
|
~/.config/Jan/data
|
||||||
|
|
||||||
```
|
```
|
||||||
|
See [Jan Data Folder](/docs/data-folder) for more details about the data folder structure.
|
||||||
|
|
||||||
<Callout type="info">
|
|
||||||
- Please see the [Jan Data Folder](/docs/data-folder) for more details about the data folder structure.
|
|
||||||
</Callout>
|
|
||||||
|
|
||||||
## GPU Acceleration
|
## GPU Acceleration
|
||||||
|
|
||||||
Once Jan is installed and you have a GPU, you can use your GPU to accelerate the model's performance.
|
Once Jan is installed and you have a GPU, you can use your GPU to accelerate the model's performance.
|
||||||
|
|
||||||
### NVIDIA GPU
|
<Tabs items={['NVIDIA GPU', 'AMD GPU', 'Intel Arc GPU']}>
|
||||||
|
|
||||||
To enable the use of your NVIDIA GPU in the Jan app, follow the steps below:
|
|
||||||
|
|
||||||
|
<Tabs.Tab>
|
||||||
<Callout type="info">
|
<Callout type="info">
|
||||||
Ensure that you have installed the following to use NVIDIA GPU:
|
Ensure that you have installed the following to use NVIDIA GPU:
|
||||||
- NVIDIA GPU with CUDA Toolkit 11.7 or higher.
|
- **NVIDIA GPU** with CUDA Toolkit 11.7 or higher
|
||||||
- NVIDIA driver 470.63.01 or higher.
|
- **NVIDIA driver** 470.63.01 or higher
|
||||||
|
|
||||||
</Callout>
|
</Callout>
|
||||||
|
|
||||||
1. Open Jan application.
|
To enable the use of your NVIDIA GPU in the Jan app, follow the steps below:
|
||||||
2. Go to **Settings** -> **Advanced Settings** -> **GPU Acceleration**.
|
1. Open Jan application
|
||||||
3. Enable and choose the NVIDIA GPU you want.
|
2. Go to **Settings** → **Advanced Settings** → **GPU Acceleration**
|
||||||
4. A success notification saying **Successfully turned on GPU acceleration** will appear when GPU acceleration is activated.
|
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>
|
||||||
|
</Tabs.Tab>
|
||||||
|
|
||||||
### AMD GPU
|
<Tabs.Tab>
|
||||||
|
|
||||||
To enable the use of your AMD GPU in the Jan app, you need to activate the Vulkan support first by following the steps below:
|
To enable the use of your AMD GPU in the Jan app, you need to activate the Vulkan support first by following the steps below:
|
||||||
|
|
||||||
1. Open Jan application.
|
1. Open Jan application
|
||||||
2. Go to **Settings** -> **Advanced Settings** -> enable the **Experimental Mode**.
|
2. Go to **Settings** → **Advanced Settings** → enable the **Experimental Mode**
|
||||||
3. Enable the **Vulkan Support** under the **GPU Acceleration**.
|
3. Enable the **Vulkan Support** under the **GPU Acceleration**
|
||||||
4. Enable the **GPU Acceleration** and choose the GPU you want to use.
|
4. Enable the **GPU Acceleration** and choose the AMD GPU you want to use
|
||||||
5. A success notification saying **Successfully turned on GPU acceleration** will appear when GPU acceleration is activated.
|
5. A success notification saying **Successfully turned on GPU acceleration** will appear when GPU acceleration is activated
|
||||||
|
</Tabs.Tab>
|
||||||
### Intel Arc GPU
|
|
||||||
|
|
||||||
|
<Tabs.Tab>
|
||||||
To enable the use of your Intel Arc GPU in the Jan app, you need to activate the Vulkan support first by following the steps below:
|
To enable the use of your Intel Arc GPU in the Jan app, you need to activate the Vulkan support first by following the steps below:
|
||||||
|
|
||||||
1. Open Jan application.
|
1. Open Jan application
|
||||||
2. Go to **Settings** -> **Advanced Settings** -> enable the **Experimental Mode**.
|
2. Go to **Settings** → **Advanced Settings** → enable the **Experimental Mode**
|
||||||
3. Enable the **Vulkan Support** under the **GPU Acceleration**.
|
3. Enable the **Vulkan Support** under the **GPU Acceleration**
|
||||||
4. Enable the **GPU Acceleration** and choose the GPU you want to use.
|
4. Enable the **GPU Acceleration** and choose the Intel Arc GPU you want to use
|
||||||
5. A success notification saying **Successfully turned on GPU acceleration** will appear when GPU acceleration is activated.
|
5. A success notification saying **Successfully turned on GPU acceleration** will appear when GPU acceleration is activated
|
||||||
|
</Tabs.Tab>
|
||||||
|
|
||||||
|
</Tabs>
|
||||||
|
|
||||||
## Uninstalling Jan
|
## Uninstall Jan
|
||||||
|
|
||||||
To uninstall Jan, follow the steps below:
|
Open **Terminal** and run these commands to remove all Jan-related data:
|
||||||
<Tabs items={['Ubuntu', 'Fedora']}>
|
<Tabs items={['Ubuntu', 'Fedora']}>
|
||||||
<Tabs.Tab>
|
<Tabs.Tab>
|
||||||
|
|
||||||
### Ubuntu
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Uninstall Jan
|
# Uninstall Jan
|
||||||
sudo apt-get remove jan
|
sudo apt-get remove jan
|
||||||
@ -276,7 +252,6 @@ rm -rf ~/.config/Jan/cache
|
|||||||
```
|
```
|
||||||
</Tabs.Tab>
|
</Tabs.Tab>
|
||||||
<Tabs.Tab>
|
<Tabs.Tab>
|
||||||
### Fedora
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Uninstall Jan
|
# Uninstall Jan
|
||||||
@ -291,9 +266,8 @@ rm -rf ~/.config/Jan/cache
|
|||||||
</Tabs.Tab>
|
</Tabs.Tab>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
<Callout type="info">
|
<Callout type="warning">
|
||||||
The deleted Data Folder cannot be restored.
|
Deleted data folders cannot be restored. Make sure to backup any important data before proceeding with deletion.
|
||||||
|
|
||||||
</Callout>
|
</Callout>
|
||||||
|
|
||||||
{/* ## FAQs
|
{/* ## FAQs
|
||||||
|
|||||||
@ -79,7 +79,7 @@ Keep in mind that this build might crash frequently or contain bugs!
|
|||||||
</Tabs.Tab>
|
</Tabs.Tab>
|
||||||
<Tabs.Tab>
|
<Tabs.Tab>
|
||||||
|
|
||||||
Nightly releases are for internal team to test new feature build everyday, which is very be buggy:
|
Nightly releases are for internal team to test new feature builds everyday, which is very be buggy:
|
||||||
|
|
||||||
[Download Jan's Nightly Version](https://app.jan.ai/download/nightly/mac-universal)
|
[Download Jan's Nightly Version](https://app.jan.ai/download/nightly/mac-universal)
|
||||||
|
|
||||||
@ -133,7 +133,9 @@ 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
|
||||||
```
|
```
|
||||||
This will completely remove Jan and all associated data from your system.
|
<Callout type="warning">
|
||||||
|
Deleted data folders cannot be restored. Make sure to backup any important data before proceeding with deletion.
|
||||||
|
</Callout>
|
||||||
|
|
||||||
{/* ## FAQs
|
{/* ## FAQs
|
||||||
|
|
||||||
|
|||||||
@ -40,8 +40,7 @@ Ensure that your system meets the following requirements to use Jan effectively:
|
|||||||
</Tabs.Tab>
|
</Tabs.Tab>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
<Callout type="info">
|
<Callout type="info">
|
||||||
- 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)
|
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.
|
||||||
- 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)
|
||||||
@ -51,11 +50,11 @@ Ensure that your system meets the following requirements to use Jan effectively:
|
|||||||
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 number of GPU layers (`ngl`) at 120 (full speed)
|
- 6GB → 3B models with **ngl** at 120 (full speed)
|
||||||
- 8GB → 7B models with number of GPU layers (`ngl`) at 120 (full speed)
|
- 8GB → 7B models with **ngl** at 120 (full speed)
|
||||||
- 12GB → 13B models with number of GPU layers (`ngl`) at 120 (full speed)
|
- 12GB → 13B models with **ngl** at 120 (full speed)
|
||||||
<Callout type="info">
|
<Callout type="info">
|
||||||
Having at least 6GB VRAM when using NVIDIA, AMD, or Intel Arc GPUs is recommended.
|
Minimum 6GB VRAM recommended for NVIDIA, AMD, or Intel Arc GPUs.
|
||||||
</Callout>
|
</Callout>
|
||||||
- **Storage:** Minimum 10GB free space for application and model downloads
|
- **Storage:** Minimum 10GB free space for application and model downloads
|
||||||
|
|
||||||
@ -87,7 +86,7 @@ Keep in mind that this build might crash frequently or contain bugs!
|
|||||||
</Tabs.Tab>
|
</Tabs.Tab>
|
||||||
<Tabs.Tab>
|
<Tabs.Tab>
|
||||||
|
|
||||||
Nightly releases are for internal team to test new feature build everyday, which is very be buggy:
|
Nightly releases are for internal team to test new feature builds everyday, which is very be buggy:
|
||||||
|
|
||||||
[Download Jan's Nightly Version](https://app.jan.ai/download/nightly/win-x64)
|
[Download Jan's Nightly Version](https://app.jan.ai/download/nightly/win-x64)
|
||||||
|
|
||||||
@ -113,76 +112,79 @@ By default, Jan is installed in the following directory:
|
|||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
<Callout type="info">
|
See [Jan Data Folder](/docs/data-folder) for more details about the data folder structure.
|
||||||
- Please see the [Jan Data Folder](/docs/data-folder) for more details about the data folder structure.
|
|
||||||
</Callout>
|
|
||||||
|
|
||||||
## GPU Acceleration
|
## GPU Acceleration
|
||||||
|
Jan can leverage your GPU to significantly improve model performance and inference speed. Here's how to enable GPU acceleration for different hardware:
|
||||||
|
|
||||||
Once Jan is installed and you have a GPU, you can use your GPU to accelerate the model's performance.
|
<Tabs items={['NVIDIA GPU', 'AMD GPU', 'Intel Arc GPU']}>
|
||||||
|
|
||||||
### NVIDIA GPU
|
<Tabs.Tab>
|
||||||
|
Before enabling NVIDIA GPU support, ensure you have:
|
||||||
To enable the use of your NVIDIA GPU in the Jan app, follow the steps below:
|
- **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:
|
||||||
|
1. Launch Jan
|
||||||
|
2. Navigate to **Settings** → **Advanced Settings** → Turn on **GPU Acceleration**
|
||||||
|
3. Select and enable your NVIDIA GPU
|
||||||
|
4. App reload is required after the selection
|
||||||
<Callout type="info">
|
<Callout type="info">
|
||||||
Ensure that you have installed the following to use NVIDIA GPU:
|
While Jan supports both CUDA and Vulkan for NVIDIA GPUs, we strongly recommend using CUDA for optimal performance.
|
||||||
- NVIDIA GPU with CUDA Toolkit 11.7 or higher.
|
|
||||||
- NVIDIA driver 470.63.01 or higher.
|
|
||||||
</Callout>
|
</Callout>
|
||||||
|
</Tabs.Tab>
|
||||||
|
|
||||||
1. Open Jan application.
|
<Tabs.Tab>
|
||||||
2. Go to **Settings** -> **Advanced Settings** -> **GPU Acceleration**.
|
AMD GPUs require **Vulkan** support, which must be activated through **Experimental Mode**.
|
||||||
3. Enable and choose the NVIDIA GPU you want.
|
1. Launch Jan
|
||||||
4. A success notification saying **Successfully turned on GPU acceleration** will appear when GPU acceleration is activated.
|
2. Navigate to **Settings** → **Advanced Settings**
|
||||||
|
3. Enable **Experimental Mode**
|
||||||
|
4. Under **GPU Acceleration**, enable **Vulkan Support**
|
||||||
|
5. Enable **GPU Acceleration** and select your AMD GPU
|
||||||
|
6. App reload is required after the selection
|
||||||
|
</Tabs.Tab>
|
||||||
|
|
||||||
<Callout type="info">
|
<Tabs.Tab>
|
||||||
While **Vulkan** can enable Nvidia GPU acceleration in the Jan app, **CUDA** is recommended for faster performance.
|
Intel Arc GPUs require **Vulkan** support, which must be activated through **Experimental Mode**.
|
||||||
</Callout>
|
1. Launch Jan
|
||||||
|
2. Navigate to **Settings** → **Advanced Settings**
|
||||||
|
3. Enable **Experimental Mode**
|
||||||
|
4. Under **GPU Acceleration**, enable **Vulkan Support**
|
||||||
|
5. Enable **GPU Acceleration** and select your Intel Arc GPU
|
||||||
|
6. App reload is required after the selection
|
||||||
|
</Tabs.Tab>
|
||||||
|
|
||||||
### AMD GPU
|
</Tabs>
|
||||||
|
|
||||||
To enable the use of your AMD GPU in the Jan app, you need to activate the Vulkan support first by following the steps below:
|
|
||||||
|
|
||||||
1. Open Jan application.
|
|
||||||
2. Go to **Settings** -> **Advanced Settings** -> enable the **Experimental Mode**.
|
|
||||||
3. Enable the **Vulkan Support** under the **GPU Acceleration**.
|
|
||||||
4. Enable the **GPU Acceleration** and choose the AMD GPU you want to use.
|
|
||||||
5. A success notification saying **Successfully turned on GPU acceleration** will appear when GPU acceleration is activated.
|
|
||||||
|
|
||||||
### Intel Arc GPU
|
|
||||||
|
|
||||||
To enable the use of your Intel Arc GPU in the Jan app, you need to activate the Vulkan support first by following the steps below:
|
|
||||||
|
|
||||||
1. Open Jan application.
|
|
||||||
2. Go to **Settings** -> **Advanced Settings** -> enable the **Experimental Mode**.
|
|
||||||
3. Enable the **Vulkan Support** under the **GPU Acceleration**.
|
|
||||||
4. Enable the **GPU Acceleration** and choose the Intel Arc GPU you want to use.
|
|
||||||
5. A success notification saying **Successfully turned on GPU acceleration** will appear when GPU acceleration is activated.
|
|
||||||
|
|
||||||
|
|
||||||
## Uninstall Jan
|
## Uninstall Jan
|
||||||
|
|
||||||
To uninstall Jan, follow the steps below:
|
### Step 1: Remove Application through Control Panel
|
||||||
|
|
||||||
### Step 1: Open the Control Panels
|
1. Open **Control Panels**
|
||||||
|
2. Go to **Programs** section
|
||||||
|
3. Click **Uninstall Program**
|
||||||
|
4. Search for **Jan**
|
||||||
|
5. Click the **three dots icon → Uninstall**
|
||||||
|
6. Click **Uninstall** again to confirm
|
||||||
|
7. Click **OK**
|
||||||
|
|
||||||
1. Open the **Control Panels**.
|
### Step 2: Handle Jan Data
|
||||||
2. Click **Uninstall Program** under the **Programs** section.
|
When prompted with: `Do you also want to delete the DEFAULT Jan data folder at C:\Users{username}\Jan?`
|
||||||
|
- Click **OK** to remove all Jan data
|
||||||
|
- Click **Cancel** to keep your Jan data for future installations
|
||||||
|
|
||||||
### Step 2: Uninstall Application
|
### Step 3: Clean Up Remaining Files
|
||||||
|
|
||||||
1. Search for **Jan**.
|
To ensure a complete uninstallation, remove the app cache:
|
||||||
2. Click the **three dots icon** -> **Uninstall**.
|
|
||||||
3. Click **Uninstall** once again to confirm the action.
|
1. Navigate to `C:\Users\[username]\AppData\Roaming`
|
||||||
4. Click **OK**.
|
2. Delete Jan folder
|
||||||
5. A message will appear: **"Do you also want to delete the DEFAULT Jan data folder at C:\Users\{username}\Jan?"**.
|
|
||||||
6. Click **OK** to delete the entire Jan data folder, or click **Cancel** to save your Jan Data folder so you can use this on the new installation folder.
|
|
||||||
7. Navigate to `users/{username}/AppData/Roaming`.
|
|
||||||
8. Delete the `Jan` folder that contains the app cache.
|
|
||||||
|
|
||||||
<Callout type="warning">
|
<Callout type="warning">
|
||||||
The deleted Data Folder cannot be restored.
|
Deleted data folders cannot be restored. Make sure to backup any important data before proceeding with deletion.
|
||||||
</Callout>
|
</Callout>
|
||||||
|
|
||||||
{/* ## FAQs
|
{/* ## FAQs
|
||||||
|
|||||||
@ -60,11 +60,10 @@ For more model installation methods, please visit [Model Management](/docs/model
|
|||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
### Step 3: Turn on the GPU Acceleration (Optional)
|
### Step 3: Turn on the GPU Acceleration (Optional)
|
||||||
While waiting for model downloading, let's customize your hardware setup. If you have a graphics card, boost model performance by enabling GPU acceleration:
|
While the model downloads, let's optimize your hardware setup. If you have a compatible graphics card, you can significantly boost model performance by enabling GPU acceleration:1. Open Jan application.
|
||||||
1. Open Jan application.
|
1. Navigate to **Settings** → **Advanced Settings** → Turn on **GPU Acceleration**
|
||||||
2. Go to **Settings** -> **Advanced Settings** -> **GPU Acceleration**.
|
2. Choose your preferred GPU
|
||||||
3. Click the Slider and choose your preferred GPU.
|
3. App reload is required after the selection
|
||||||
3. A success notification saying **Successfully turned on GPU acceleration** will appear when GPU acceleration is activated.
|
|
||||||
<Callout type="info">
|
<Callout type="info">
|
||||||
Ensure you have installed your GPU driver. Please see [Desktop](/docs/desktop) for more information on activating the GPU acceleration.
|
Ensure you have installed your GPU driver. Please see [Desktop](/docs/desktop) for more information on activating the GPU acceleration.
|
||||||
</Callout>
|
</Callout>
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user