diff --git a/docs/docs/guides/04-using-models/01-install-from-hub.mdx b/docs/docs/guides/04-using-models/01-install-from-hub.mdx index 1f1b97b0c..6088c6f74 100644 --- a/docs/docs/guides/04-using-models/01-install-from-hub.mdx +++ b/docs/docs/guides/04-using-models/01-install-from-hub.mdx @@ -13,3 +13,41 @@ keywords: large language model, ] --- + +In this guide, we will walk through the process of installing a **Large Language Model (LLM)** from the Hub. + +![Getting Started Highlight](assets/01-getting-started-install.gif) + +## Steps to Install Models from the Hub + +### 1. Explore and Select a Model + +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 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). + +![Search Model](assets/01-filter-button.png) + +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 Model + +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) + +### 3. Use the Model + +Once the download is completed, you can start using the model by clicking the **Use** button. + +![Use Model](assets/01-use-model.gif) diff --git a/docs/docs/guides/04-using-models/assets/01-download-progress.png b/docs/docs/guides/04-using-models/assets/01-download-progress.png new file mode 100644 index 000000000..c410186d5 Binary files /dev/null and b/docs/docs/guides/04-using-models/assets/01-download-progress.png differ diff --git a/docs/docs/guides/04-using-models/assets/01-filter-button.png b/docs/docs/guides/04-using-models/assets/01-filter-button.png new file mode 100644 index 000000000..4271b0ceb Binary files /dev/null and b/docs/docs/guides/04-using-models/assets/01-filter-button.png differ diff --git a/docs/docs/guides/04-using-models/assets/01-getting-started-install.gif b/docs/docs/guides/04-using-models/assets/01-getting-started-install.gif new file mode 100644 index 000000000..a9665814f Binary files /dev/null and b/docs/docs/guides/04-using-models/assets/01-getting-started-install.gif differ diff --git a/docs/docs/guides/04-using-models/assets/01-search-model.gif b/docs/docs/guides/04-using-models/assets/01-search-model.gif new file mode 100644 index 000000000..95f5cc9c0 Binary files /dev/null and b/docs/docs/guides/04-using-models/assets/01-search-model.gif differ diff --git a/docs/docs/guides/04-using-models/assets/01-use-model.gif b/docs/docs/guides/04-using-models/assets/01-use-model.gif new file mode 100644 index 000000000..e2ef5f0ba Binary files /dev/null and b/docs/docs/guides/04-using-models/assets/01-use-model.gif differ