Skip to content

Commit

Permalink
docs: Update 02-import-manually.mdx
Browse files Browse the repository at this point in the history
  • Loading branch information
freelerobot authored Jan 9, 2024
1 parent a5ed285 commit d52c183
Showing 1 changed file with 69 additions and 2 deletions.
71 changes: 69 additions & 2 deletions docs/docs/guides/04-using-models/02-import-manually.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,79 @@ This is currently under development.
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

## Steps to Manually Import a Local Model

In this section, we will show you how to import a GGUF model from [HuggingFace](https://huggingface.co/), using our latest model, [Trinity](https://huggingface.co/janhq/trinity-v1-GGUF), as an example.

> We are fast shipping a UI to make this easier, but it's a bit manual for now. Apologies.
## Manually Importing a Downloaded Model (nightly versions and v0.4.4+)


### 1. Create a Model Folder

Navigate to the `~/jan/models` folder. You can find this folder by going to `App Settings` > `Advanced` > `Open App Directory`.

<Tabs groupId="operating-systems">
<TabItem value="mac" label="macOS">

```sh
cd ~/jan/models
```

</TabItem>
<TabItem value="win" label="Windows">

```sh
C:/Users/<your_user_name>/jan/models
```

</TabItem>
<TabItem value="linux" label="Linux">

```sh
cd ~/jan/models
```

</TabItem>
</Tabs>

In the `models` folder, create a folder with the name of the model.

<Tabs groupId="operating-systems">
<TabItem value="mac" label="macOS">

```sh
mkdir trinity-v1-7b
```

</TabItem>
<TabItem value="win" label="Windows">

```sh
mkdir trinity-v1-7b
```

</TabItem>
<TabItem value="linux" label="Linux">

```sh
mkdir trinity-v1-7b
```

</TabItem>
</Tabs>

#### 2. Drag & Drop the Model

Drag and drop your model binary into this folder, ensuring the `modelname.gguf` is the same name as the folder name, e.g. `models/modelname`

#### 3. Voila

If your model doesn't show up in the Model Selector in conversations, please restart the app.

If that doesn't work, please feel free to join our [Discord community](https://discord.gg/Dt7MxDyNNZ) for support, updates, and discussions.

## Manually Importing a Downloaded Model (older versions)

### 1. Create a Model Folder

Navigate to the `~/jan/models` folder. You can find this folder by going to `App Settings` > `Advanced` > `Open App Directory`.
Expand Down

0 comments on commit d52c183

Please sign in to comment.