Docs for Installing Models from Hub

orinocoz · Jan 8, 2024 · 6800888 · 6800888
1 parent fc151fb
commit 6800888
Show file tree

Hide file tree

Showing 7 changed files with 43 additions and 0 deletions.
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
@@ -13,3 +13,46 @@ 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
+
+### 1. Search the LLM that you want to use from the Hub
+
+Explore all the LLM available by scrolling, or use 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|
+
+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)
+
+### 2. Download the LLM
+
+Once you've identified the desired LLM, simply click the **Download Button** to initiate the download.
+
+![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)
+
+Now you're ready to [Start a Thread](../03-chatting/04-start-thread.mdx).
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
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
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
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
diff --git a/docs/docs/guides/04-using-models/assets/01-use-base.png b/docs/docs/guides/04-using-models/assets/01-use-base.png
diff --git a/docs/docs/guides/04-using-models/assets/01-use-button.png b/docs/docs/guides/04-using-models/assets/01-use-button.png