Update Overview, Quickstart & Installation pages

This commit is contained in:
Ashley 2024-12-30 21:09:58 +07:00
parent 42353d940f
commit 60bb719a53
7 changed files with 33 additions and 25 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.3 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.9 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 MiB

View File

@ -192,11 +192,10 @@ 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>
<Callout type="info"> Before enabling NVIDIA GPU support, ensure you have:
Ensure that you have installed the following to use NVIDIA GPU: - **CUDA Toolkit** 11.7 or higher installed
- **NVIDIA GPU** with CUDA Toolkit 11.7 or higher - **NVIDIA driver** version 470.63.01 or higher
- **NVIDIA driver** 470.63.01 or higher
</Callout>
To enable the use of your NVIDIA GPU in the Jan app, follow the steps below: To enable the use of your NVIDIA GPU in the Jan app, follow the steps below:
1. Open Jan application 1. Open Jan application

View File

@ -37,7 +37,7 @@ Once installed, you'll see the Jan application interface with no local models pr
- Connect to cloud AI providers if desired - Connect to cloud AI providers if desired
<br/> <br/>
![Default State](./_assets/default.gif) ![Default State](./_assets/Step1.gif)
<br/> <br/>
@ -55,54 +55,63 @@ For more model installation methods, please visit [Model Management](/docs/model
<br/> <br/>
![Download a Model](./_assets/download-model2.gif) ![Download a Model](./_assets/Step2.gif)
<br/> <br/>
### Step 3: Turn on the GPU Acceleration (Optional) ### Step 3: Turn on the GPU Acceleration (Optional)
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. 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. Navigate to **Settings** → **Advanced Settings** → Turn on **GPU Acceleration** 1. Navigate to **Settings** → **Advanced Settings** → Turn on **GPU Acceleration**
2. Choose your preferred GPU 2. Choose your preferred GPU
3. App reload is required after the selection 3. App reload is required after the selection
<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 all required dependencies and drivers before enabling GPU acceleration. See **GPU Setup Guide** on [Windows](/docs/desktop/windows#gpu-acceleration) & [Linux](/docs/desktop/linux#gpu-acceleration) for detailed instructions.
</Callout> </Callout>
<br/> <br/>
![Turn on GPU acceleration](./_assets/gpu2.gif) ![Turn on GPU acceleration](./_assets/gpu2.gif)
### Step 4: Customize the Assistant Instruction ### Step 4: Customize Assistant Instructions
Customize Jan's assistant behavior by specifying queries, commands, or requests in the Assistant Instructions field to get the most responses from your assistant. To customize, follow the steps below: Once your model has downloaded and you're ready to start your first conversation with Jan, you can customize how it responds by setting specific instructions:
1. On the **Thread** section, navigate to the right panel. 1. In any **Thread**, click the **Assistant** tab in the **right panel**
2. Select the **Assistant** tab menu. 2. Enter your instructions in the **Instructions** field to define how Jan should respond
3. Provide a specific guideline under the **Instructions** field.
You can modify these instructions at any time during your conversation to adjust Jan's behavior for that specific thread.
<br/> <br/>
![Assistant Instruction](./_assets/asst.gif) ![Assistant Instruction](./_assets/Step4.gif)
<br/> <br/>
### Step 5: Start Thread ### Step 5: Start Chatting and Fine-tune Settings
Now that your model is downloaded and instructions are set, you can begin chatting with Jan. Type your message in the **input field** at the bottom of the thread to start the conversation.
You can further customize your experience by:
- Adjusting [model parameters](/docs/models/model-parameters) in the **Model** tab in the **right panel**
- Trying different models for different tasks by clicking the **model selector** in **Model** tab or **input field**
- Creating new threads with different instructions and model configurations
Once you have downloaded a model and customized your assistant instruction, you can start chatting with the model.
<br/> <br/>
![Chat with a Model](./_assets/chat.gif) ![Chat with a Model](./_assets/Step5.gif)
<br/> <br/>
### Step 6: Connect to a Remote API ### Step 6: Connect to cloud models (Optional)
Jan also offers access to remote models hosted on external servers. You can link up with any Remote AI APIs compatible with OpenAI. Jan comes with numerous extensions that facilitate connections to various remote AI APIs. To explore and connect to Remote APIs, follow these steps: Jan supports both local and remote AI models. You can connect to remote AI services that are OpenAI API-compatible, including: OpenAI (GPT-4, o1,...), Anthropic (Claude), Groq, Mistral, and more.
1. On the **Thread** section, navigate to the right panel. 1. Open any **Thread**
2. Select the **Model** tab menu. 2. Click the **Model** tab in the **right panel** or the **model selector** in input field
3. Next to the **OpenAI** models -> click the **Gear Icon (⚙️)**. 3. Choose the **Cloud** tab
4. Enter your OpenAI API **Keys**. 4. Choose your preferred provider (Anthropic, OpenAI, etc.)
5. Click the **Settings** icon ⚙️ next to the provider to add your API key
<br/> <br/>
![Connect Remote API](./_assets/server-openai2.gif) ![Connect Remote API](./_assets/Step6.gif)
<br/> <br/>
</Steps> </Steps>