Nicholai/jan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Update 02-import-manually.mdx

Browse Source
This commit is contained in:
0xSage 2024-01-09 14:21:21 +08:00 committed by GitHub
parent a5ed285708
commit d52c183482
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 69 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
docs/docs/guides/04-using-models/02-import-manually.mdx
View File

@ -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`.