Documentation
Quickstart

Quickstart

To quickly get started, follow the steps below:

Step 1: Install Jan Desktop

Before using Jan, you need to install Jan. Jan can be installed through:

Step 2: Download a Model

Jan provides a variety of local AI models tailored to different needs and is ready for download. These models are installed and run directly on the user's device.

  1. Go to the Hub.
  2. Select the models that you would like to install. To see model details, click the dropdown button.

Ensure you select the appropriate model size by balancing performance, cost, and resource considerations in line with your task's specific requirements and hardware specifications.

  1. Click the Download button.

Download a Model


Step 3: Connect to ChatGPT (Optional)

Jan also provides access to remote models hosted on external servers, requiring an API key for connectivity. For example, to use the ChatGPT model with Jan, you must input your API key by following these steps:

  1. Go to the Thread tab.
  2. Under the Model dropdown menu, select the ChatGPT model.
  3. Fill in your ChatGPT API Key that you can get in your OpenAI platform (opens in a new tab).

Download a Model


Step 4: Configure the Model

After downloading, configure the model to fit your requirements and hardware specs by following these steps:

  1. Go to the Thread tab.
  2. Click the Model dropdown button.
  3. Choose the downloaded model, either Local or Remote.
  4. Adjust the configurations as needed.

    Please see Using Models for detailed model configuration.


Configure a Model


Step 5: Start the Model

After downloading and configuring your model, you can chat with the model.


Chat with a Model


Best Practices

This section outlines best practices for developers, analysts, and AI enthusiasts to enhance their experience with Jan when adding AI locally to their computers. Implementing these practices will optimize the performance of AI models.

Follow the Quickstart Guide

The quickstart guide above is designed to facilitate a quick setup process. It provides clear instructions and simple steps to get you up and running with Jan quickly, even if you are inexperienced in AI.

Select the Right Models

Jan offers a range of pre-configured AI models suited for different purposes. You should identify which one that aligns with your objectives. There are factors to be considered:

  • Capabilities
  • Accuracy
  • Processing Speed
  • Some of these factors also depend on your hardware. Please see the Hardware Requirements section.
  • Choosing the right model is important to achieve the best performance.

Setting up Jan

Ensure that you familiarize yourself with the Jan application. Jan offers advanced settings that you can adjust. These settings may influence how your AI behaves locally. Please see the Advanced Settings article for a complete list of Jan's configurations and instructions on configuring them.

Integrations

Jan can work with many different systems and tools. Whether you are incorporating Jan with any open-source LLM provider or other tools, it is important to understand the integration capabilities and limitations.

Mastering the Prompt Engineering

Prompt engineering is important when dealing with AI models to generate the desired outputs. Mastering this skill can significantly enhance the AI's performance and responses. Below are some tips that you can do for prompt engineering:

  • Ask the model to adopt a persona
  • Be specific and details get a more specific answers
  • Provide examples or preference text or context at the beginning
  • Use a clear and concise language
  • Use specific keywords and phrases

Pre-configured Models

To see the complete list of Jan's pre-configured models, please visit our official GitHub here (opens in a new tab).