docs: add common error content
This commit is contained in:
Arista Indrajaya
parent
9210d20591
commit
94e8b23365
8
docs/docs/quickstart/common-error/_category_.json
Normal file
8
docs/docs/quickstart/common-error/_category_.json
Normal file
@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "Common Error",
|
||||
"position": 8,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "List of common errors for Jan users"
|
||||
}
|
||||
}
|
||||
147
docs/docs/quickstart/common-error/broken-build.mdx
Normal file
147
docs/docs/quickstart/common-error/broken-build.mdx
Normal file
@ -0,0 +1,147 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
hide_table_of_contents: true
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Broken Build
|
||||
|
||||
The `Broken Build` issue is caused by Jan's unstable build after installation. To resolve solve it, follow the following steps
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="mac" label="Mac" default>
|
||||
### 1. Uninstall Jan
|
||||
|
||||
Delete Jan from your `/Applications` folder.
|
||||
|
||||
### 2. Delete Application Data, Cache, and User Data
|
||||
|
||||
```zsh
|
||||
# Step 1: Delete the application data
|
||||
## Newer versions
|
||||
rm -rf ~/Library/Application\ Support/jan
|
||||
## Versions 0.2.0 and older
|
||||
rm -rf ~/Library/Application\ Support/jan-electron
|
||||
|
||||
# Step 2: Clear application cache
|
||||
rm -rf ~/Library/Caches/jan*
|
||||
|
||||
# Step 3: Remove all user data
|
||||
rm -rf ~/jan
|
||||
```
|
||||
|
||||
### 3. Additional Step for Versions Before 0.4.2
|
||||
|
||||
If you are using a version before `0.4.2`, you need to run the following commands:
|
||||
|
||||
```zsh
|
||||
ps aux | grep nitro
|
||||
# Looks for processes like `nitro` and `nitro_arm_64`, and kill them one by one by process ID
|
||||
kill -9 <PID>
|
||||
```
|
||||
|
||||
### 4. Download the Latest Version
|
||||
|
||||
Download the latest version of Jan from our [homepage](https://jan.ai/).
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="windows" label="Windows">
|
||||
### 1. Uninstall Jan
|
||||
|
||||
To uninstall Jan on Windows, use the [Windows Control Panel](https://support.microsoft.com/en-us/windows/uninstall-or-remove-apps-and-programs-in-windows-4b55f974-2cc6-2d2b-d092-5905080eaf98).
|
||||
|
||||
### 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`
|
||||
cd C:\Users\%USERNAME%\AppData\Roaming
|
||||
rmdir /S jan
|
||||
```
|
||||
|
||||
### 3. Additional Step for Versions Before 0.4.2
|
||||
|
||||
If you are using a version before `0.4.2`, you need to run the following commands:
|
||||
|
||||
```sh
|
||||
# Find the process ID (PID) of the nitro process by filtering the list by process name
|
||||
tasklist | findstr "nitro"
|
||||
# Once you have the PID of the process you want to terminate, run the `taskkill`
|
||||
taskkill /F /PID <PID>
|
||||
```
|
||||
|
||||
### 4. Download the Latest Version
|
||||
|
||||
Download the latest version of Jan from our [homepage](https://jan.ai/).
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="linux" label="Linux">
|
||||
|
||||
### 1. Uninstall Jan
|
||||
|
||||
<Tabs groupId = "linux_type">
|
||||
<TabItem value="linux_main" label = "Linux">
|
||||
|
||||
To uninstall Jan, you should use your package manager's uninstall or remove option.
|
||||
|
||||
This will return your system to its state before the installation of Jan.
|
||||
|
||||
This method can also reset all settings if you are experiencing any issues with Jan.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value = "deb_ub" label = "Debian / Ubuntu">
|
||||
|
||||
To uninstall Jan, run the following command.MDXContent
|
||||
|
||||
```sh
|
||||
sudo apt-get remove jan
|
||||
# where jan is the name of Jan package
|
||||
```
|
||||
|
||||
This will return your system to its state before the installation of Jan.
|
||||
|
||||
This method can also be used to reset all settings if you are experiencing any issues with Jan.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value = "other" label = "Others">
|
||||
|
||||
To uninstall Jan, you can uninstall Jan by deleting the `.AppImage` file.
|
||||
|
||||
If you wish to completely remove all user data associated with Jan after uninstallation, you can delete the user data at `~/jan`.
|
||||
|
||||
This method can also reset all settings if you are experiencing any issues with Jan.
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### 2. Delete Application Data, Cache, and User Data
|
||||
|
||||
```sh
|
||||
# You can delete the user data folders located at the following `~/jan`
|
||||
rm -rf ~/jan
|
||||
```
|
||||
|
||||
### 3. Additional Step for Versions Before 0.4.2
|
||||
|
||||
If you are using a version before `0.4.2`, you need to run the following commands:
|
||||
|
||||
```zsh
|
||||
ps aux | grep nitro
|
||||
# Looks for processes like `nitro` and `nitro_arm_64`, and kill them one by one by process ID
|
||||
kill -9 <PID>
|
||||
```
|
||||
|
||||
### 4. Download the Latest Version
|
||||
|
||||
Download the latest version of Jan from our [homepage](https://jan.ai/).
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
By following these steps, you can cleanly uninstall and reinstall Jan, ensuring a smooth and error-free experience with the latest version.
|
||||
|
||||
:::note
|
||||
|
||||
Before reinstalling Jan, ensure it's completely removed from all shared spaces if it's installed on multiple user accounts on your device.
|
||||
|
||||
:::
|
||||
128
docs/docs/quickstart/common-error/not-using-gpu.mdx
Normal file
128
docs/docs/quickstart/common-error/not-using-gpu.mdx
Normal file
@ -0,0 +1,128 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
import switchGPU from "./assets/janSwitchCPUtoGPU.gif";
|
||||
import openDirectory from "./assets/janOpenAppDirectory.gif";
|
||||
|
||||
# Jan not using GPU
|
||||
|
||||
The `Jan not using GPU` issue is caused due to Jan app does not utilize the GPU on Windows and Linux systems.
|
||||
|
||||
### GPU Mode Requirements for Windows and Linux
|
||||
|
||||
#### NVIDIA Driver
|
||||
|
||||
- Install an NVIDIA driver supporting CUDA 11.7 or higher.
|
||||
- Use the following command to verify the installation:
|
||||
|
||||
```sh
|
||||
nvidia-smi
|
||||
```
|
||||
|
||||
#### CUDA Toolkit
|
||||
|
||||
- Install a CUDA toolkit compatible with your NVIDIA driver.
|
||||
- Use the following command to verify the installation:
|
||||
|
||||
```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.
|
||||
|
||||
### Switching CPU/GPU Modes
|
||||
|
||||
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
|
||||
|
||||
If GPU mode isn't enabled by default:
|
||||
|
||||
1. Confirm that you have installed an NVIDIA driver supporting CUDA 11.7 or higher. 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).
|
||||
|
||||
### Checking 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:
|
||||
|
||||
```json title="~/jan/settings/settings.json"
|
||||
{
|
||||
"notify": true,
|
||||
"run_mode": "gpu",
|
||||
"nvidia_driver": {
|
||||
"exist": true,
|
||||
"version": "531.18"
|
||||
},
|
||||
"cuda": {
|
||||
"exist": true,
|
||||
"version": "12"
|
||||
},
|
||||
"gpus": [
|
||||
{
|
||||
"id": "0",
|
||||
"vram": "12282"
|
||||
},
|
||||
{
|
||||
"id": "1",
|
||||
"vram": "6144"
|
||||
},
|
||||
{
|
||||
"id": "2",
|
||||
"vram": "6144"
|
||||
}
|
||||
],
|
||||
"gpu_highest_vram": "0"
|
||||
}
|
||||
```
|
||||
|
||||
#### Troubleshooting Tips
|
||||
|
||||
- Ensure `nvidia_driver` and `cuda` fields indicate installed software.
|
||||
- If `gpus` field is empty or lacks your GPU, check NVIDIA driver and CUDA toolkit installations.
|
||||
- For further assistance, share the `settings.json` file.
|
||||
|
||||
### Tested Configurations
|
||||
|
||||
- **Windows 11 Pro 64-bit:**
|
||||
- GPU: NVIDIA GeForce RTX 4070ti
|
||||
- CUDA: 12.2
|
||||
- NVIDIA driver: 531.18 (Bare metal)
|
||||
|
||||
- **Ubuntu 22.04 LTS:**
|
||||
- GPU: NVIDIA GeForce RTX 4070ti
|
||||
- CUDA: 12.2
|
||||
- NVIDIA driver: 545 (Bare metal)
|
||||
|
||||
- **Ubuntu 20.04 LTS:**
|
||||
- GPU: NVIDIA GeForce GTX 1660ti
|
||||
- CUDA: 12.1
|
||||
- NVIDIA driver: 535 (Proxmox VM passthrough GPU)
|
||||
|
||||
- **Ubuntu 18.04 LTS:**
|
||||
- GPU: NVIDIA GeForce GTX 1660ti
|
||||
- CUDA: 12.1
|
||||
- NVIDIA driver: 535 (Proxmox VM passthrough GPU)
|
||||
|
||||
### Common Issues and Solutions
|
||||
|
||||
1. If the issue persists, try installing the [Nightly version](https://jan.ai/install/nightly/).
|
||||
2. Ensure your (V)RAM is accessible; some users with virtual RAM may require additional configuration.
|
||||
3. Seek assistance in [Jan Discord](https://discord.gg/mY69SZaMaC).
|
||||
Loading…
x
Reference in New Issue
Block a user