docs: update common-error section by add keywords for each page
This commit is contained in:
Arista Indrajaya
parent
66cdd8831b
commit
328bb6baab
@ -1,18 +1,26 @@
|
|||||||
---
|
---
|
||||||
|
title: Broken Build
|
||||||
sidebar_position: 1
|
sidebar_position: 1
|
||||||
hide_table_of_contents: true
|
hide_table_of_contents: true
|
||||||
|
description: A step-by-step guide to fix errors that prevent the project from compiling or running successfully.
|
||||||
|
keywords:
|
||||||
|
[
|
||||||
|
Jan AI,
|
||||||
|
Jan,
|
||||||
|
ChatGPT alternative,
|
||||||
|
local AI,
|
||||||
|
private AI,
|
||||||
|
conversational AI,
|
||||||
|
no-subscription fee,
|
||||||
|
large language model,
|
||||||
|
troubleshooting,
|
||||||
|
]
|
||||||
---
|
---
|
||||||
|
|
||||||
import Tabs from '@theme/Tabs';
|
import Tabs from '@theme/Tabs';
|
||||||
import TabItem from '@theme/TabItem';
|
import TabItem from '@theme/TabItem';
|
||||||
|
|
||||||
# Broken Build
|
This guide provides you steps to troubleshoot and to resolve the issue where your Jan is stuck in a broken build after installation.
|
||||||
|
|
||||||
A step-by-step guide to fix errors that prevent the project from compiling or running successfully.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
The `Broken Build` issue is caused by Jan's unstable build after installation. To resolve solve it, follow the following steps
|
|
||||||
|
|
||||||
<Tabs>
|
<Tabs>
|
||||||
<TabItem value="mac" label="Mac" default>
|
<TabItem value="mac" label="Mac" default>
|
||||||
|
|||||||
@ -1,54 +1,86 @@
|
|||||||
---
|
---
|
||||||
|
title: Jan not using GPU
|
||||||
sidebar_position: 2
|
sidebar_position: 2
|
||||||
|
description: A step-by-step guide to enable Jan to properly leverage GPU resources, avoiding performance issues.
|
||||||
|
keywords: [
|
||||||
|
Jan AI,
|
||||||
|
Jan,
|
||||||
|
ChatGPT alternative,
|
||||||
|
local AI,
|
||||||
|
private AI,
|
||||||
|
convZ
|
||||||
|
ersational AI,
|
||||||
|
no-subscription fee,
|
||||||
|
large language model,
|
||||||
|
troubleshooting,
|
||||||
|
using GPU,
|
||||||
|
]
|
||||||
---
|
---
|
||||||
|
|
||||||
import switchGPU from "./assets/janSwitchCPUtoGPU.gif";
|
import Tabs from '@theme/Tabs';
|
||||||
import openDirectory from "./assets/janOpenAppDirectory.gif";
|
import TabItem from '@theme/TabItem';
|
||||||
|
|
||||||
# Jan not using GPU
|
|
||||||
|
|
||||||
A step-by-step guide to enable Jan to properly leverage GPU resources, avoiding performance issues.
|
This guide provides steps to troubleshoot and resolve issues when the Jan app does not utilize the GPU on Windows and Linux systems.
|
||||||
|
|
||||||
---
|
### 1. Ensure GPU Mode Requirements
|
||||||
|
|
||||||
The `Jan not using GPU` issue is caused due to Jan app does not utilize the GPU on Windows and Linux systems.
|
<Tabs>
|
||||||
|
<TabItem value="windows" label="Windows">
|
||||||
|
|
||||||
|
#### NVIDIA Driver
|
||||||
|
|
||||||
### GPU Mode Requirements for Windows and Linux
|
- Install an NVIDIA driver supporting CUDA 11.7 or higher.
|
||||||
|
- Use the following command to verify the installation:
|
||||||
|
|
||||||
#### NVIDIA Driver
|
```sh
|
||||||
|
nvidia-smi
|
||||||
|
```
|
||||||
|
|
||||||
- Install an NVIDIA driver supporting CUDA 11.7 or higher.
|
#### CUDA Toolkit
|
||||||
- Use the following command to verify the installation:
|
|
||||||
|
|
||||||
```sh
|
- Install a CUDA toolkit compatible with your NVIDIA driver.
|
||||||
nvidia-smi
|
- Use the following command to verify the installation:
|
||||||
```
|
|
||||||
|
|
||||||
#### CUDA Toolkit
|
```sh
|
||||||
|
nvcc --version
|
||||||
|
```
|
||||||
|
|
||||||
- Install a CUDA toolkit compatible with your NVIDIA driver.
|
</TabItem>
|
||||||
- Use the following command to verify the installation:
|
<TabItem value="linux" label="Linux">
|
||||||
|
|
||||||
|
#### NVIDIA Driver
|
||||||
|
|
||||||
```sh
|
- Install an NVIDIA driver supporting CUDA 11.7 or higher.
|
||||||
nvcc --version
|
- Use the following command to verify the installation:
|
||||||
```
|
|
||||||
|
|
||||||
#### Linux Specifics
|
```sh
|
||||||
|
nvidia-smi
|
||||||
|
```
|
||||||
|
|
||||||
- Ensure that `gcc-11`, `g++-11`, `cpp-11`, or higher is installed.
|
#### CUDA Toolkit
|
||||||
- See [instructions](https://gcc.gnu.org/projects/cxx-status.html#cxx17) for Ubuntu installation.
|
|
||||||
|
|
||||||
- **Post-Installation Actions**: Add CUDA libraries to `LD_LIBRARY_PATH`.
|
- Install a CUDA toolkit compatible with your NVIDIA driver.
|
||||||
- Follow the [Post-installation Actions](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html#post-installation-actions) instructions.
|
- Use the following command to verify the installation:
|
||||||
|
|
||||||
### Switching CPU/GPU Modes
|
```sh
|
||||||
|
nvcc --version
|
||||||
|
```
|
||||||
|
#### Linux Specifics
|
||||||
|
|
||||||
|
- Ensure that `gcc-11`, `g++-11`, `cpp-11`, or higher is installed.
|
||||||
|
- See [instructions](https://gcc.gnu.org/projects/cxx-status.html#cxx17) for Ubuntu installation.
|
||||||
|
|
||||||
|
- **Post-Installation Actions**: Add CUDA libraries to `LD_LIBRARY_PATH`.
|
||||||
|
- Follow the [Post-installation Actions](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html#post-installation-actions) instructions.
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
</Tabs>
|
||||||
|
|
||||||
|
### 2. Switch to GPU Mode
|
||||||
|
|
||||||
Jan defaults to CPU mode but automatically switches to GPU mode if your system supports it, selecting the GPU with the highest VRAM. Check this setting in `Settings` > `Advanced Settings`.
|
Jan defaults to CPU mode but automatically switches to GPU mode if your system supports it, selecting the GPU with the highest VRAM. Check this setting in `Settings` > `Advanced Settings`.
|
||||||
|
|
||||||
<div class="text--center" >
|
|
||||||
<img src={ switchGPU } width = { 800 } alt = "janSwitchCPUtoGPU" />
|
|
||||||
</div>
|
|
||||||
|
|
||||||
#### Troubleshooting Tips
|
#### Troubleshooting Tips
|
||||||
|
|
||||||
If GPU mode isn't enabled by default:
|
If GPU mode isn't enabled by default:
|
||||||
@ -57,14 +89,9 @@ If GPU mode isn't enabled by default:
|
|||||||
2. Ensure compatibility of the CUDA toolkit with your NVIDIA driver. Refer to [CUDA compatibility](https://docs.nvidia.com/deploy/cuda-compatibility/index.html#binary-compatibility__table-toolkit-driver).
|
2. Ensure compatibility of the CUDA toolkit with your NVIDIA driver. Refer to [CUDA compatibility](https://docs.nvidia.com/deploy/cuda-compatibility/index.html#binary-compatibility__table-toolkit-driver).
|
||||||
3. For Linux, add CUDA's `.so` libraries to the `LD_LIBRARY_PATH`. For Windows, ensure that CUDA's `.dll` libraries are in the PATH. Refer to [Windows setup](https://docs.nvidia.com/cuda/cuda-installation-guide-microsoft-windows/index.html#environment-setup).
|
3. For Linux, add CUDA's `.so` libraries to the `LD_LIBRARY_PATH`. For Windows, ensure that CUDA's `.dll` libraries are in the PATH. Refer to [Windows setup](https://docs.nvidia.com/cuda/cuda-installation-guide-microsoft-windows/index.html#environment-setup).
|
||||||
|
|
||||||
### Checking GPU Settings
|
### 3. Check GPU Settings
|
||||||
|
|
||||||
1. Navigate to `Settings` > `Advanced Settings` > `Jan Data Folder` to access GPU settings.
|
1. Navigate to `Settings` > `Advanced Settings` > `Jan Data Folder` to access GPU settings.
|
||||||
|
|
||||||
<div class="text--center" >
|
|
||||||
<img src={ openDirectory } width = { 800 } alt = "janOpenAppDirectory" />
|
|
||||||
</div>
|
|
||||||
|
|
||||||
2. Open the `settings.json` file in the `settings` folder. Here's an example:
|
2. Open the `settings.json` file in the `settings` folder. Here's an example:
|
||||||
|
|
||||||
```json title="~/jan/settings/settings.json"
|
```json title="~/jan/settings/settings.json"
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user