Skip to content

Commit

Permalink
docs: add high quality gif
Browse files Browse the repository at this point in the history
  • Loading branch information
0xHieu01 committed Jan 8, 2024
1 parent 6800888 commit 41f3c42
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 21 deletions.
37 changes: 16 additions & 21 deletions docs/docs/guides/04-using-models/01-install-from-hub.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,46 +13,41 @@ keywords:
large language model,
]
---
![Getting Started Highlight](assets/01-getting-started-install.gif)

In this guide, we will walk through the process of installing a **Large Language Model (LLM)** from the Hub.

## Steps to Install Large Language Model (LLM) from Hub
![Getting Started Highlight](assets/01-getting-started-install.gif)

## Steps to Install Models from the Hub

### 1. Search the LLM that you want to use from the Hub
### 1. Explore and Select a Model

Explore all the LLM available by scrolling, or use the **Search Bar**
Explore the available LLMs by scrolling through the Hub or using the **Search Bar**.

![Search Model](assets/01-search-model.gif)

Utilize the **Filter Button** to choose the **Recommended LLM**.

| Name | Description |
| ---- | ----------- |
| All Models | Show all LLM available |
| Recommended | Show the Recommended LLM |
| Downloaded | Show the LLM that has been downloaded|
| Name | Description |
| ----------- | ------------------------------------- |
| All Models | Show all LLMs available |
| Recommended | Show the Recommended LLM |
| Downloaded | Show the LLM that has been downloaded |

LLM is Recommended based on the [RAM usage](https://github.com/janhq/jan/issues/1384)
LLM is recommended based on the [RAM usage](https://github.com/janhq/jan/issues/1384).

![Search Model](assets/01-filter-button.png)

If the LLM that you want to use isn't currently available, you can also [Import the Model Manually](./02-import-manually.mdx)
If you want to use a model that is not available in the Hub, you can also [import the Model Manually](./02-import-manually.mdx).

### 2. Download the LLM
### 2. Download the Model

Once you've identified the desired LLM, simply click the **Download Button** to initiate the download.
Once you've identified the desired LLM, simply click the **Download** button to initiate the download. A progress bar will appear to indicate the download progress.

![Download Progress](assets/01-download-progress.png)

Please wait for the model download to finish before the **Use Button** becomes available.

### 3. Use the Model

![Use Model Button](assets/01-use-button.png)

Upon clicking the **Use Button**, you will be directed to the corresponding **Thread Screen** below.

![Thread Screen](assets/01-use-base.png)
Once the download is completed, you can start using the model by clicking the **Use** button.

Now you're ready to [Start a Thread](../03-chatting/04-start-thread.mdx).
![Use Model](assets/01-use-model.gif)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/docs/guides/04-using-models/assets/01-search-model.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 41f3c42

Please sign in to comment.