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

Add small notes to Models spec

Browse Source
This commit is contained in:
Daniel 2023-11-19 12:00:29 +08:00
parent 3595bb4eb1
commit d8de588abe
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/docs/specs/models.md
View File

@ -33,6 +33,15 @@ Models in Jan are stored in the `/models` folder.
- The `folder` and `file` do not have to share the same name - The `folder` and `file` do not have to share the same name
- The model `id` is made up of `folder_name/filename` and is thus always unique. - The model `id` is made up of `folder_name/filename` and is thus always unique.
Folders are human readable names
### Auto-detection
You can import a model by just dragging it into the `/models` folder
- Jan will detect and generate a corresponding `.json` file based on filename
- Jan will move it into its own folder once you choose a human readable name for it
- Jan will fill out the model.json file as you add metadata through the UI
```sh ```sh
/janroot /janroot
/models /models