docs: fixes

This commit is contained in:
0xSage 2023-11-17 13:36:08 +08:00
parent 75365b22fa
commit fb24f775d1

View File

@ -133,34 +133,63 @@ Supported URL formats with custom importers:
## Filesystem ## Filesystem
How `models` map onto your local filesystem - Everything needed to represent a `model` is packaged into an `Model folder`.
- The folder is standalone and can be easily zipped, imported, and exported, e.g. to Github.
- The folder always contains at least one `Model Object`, declared in a `json` format.
- 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.
```shell= ```sh
/janroot /janroot
/models /models
azure-openai/ azure-openai/ # Folder name
azure-openai-gpt3-5.json azure-openai-gpt3-5.json # File name
llama2-70b/ llama2-70b/
model.json model.json
.gguf .gguf
```
### Default model package
- Jan ships iwht a dfault model package containing recommended models
- ONly the Model Object `json` files are included
- Users must explicitly download the model binaries
```sh
mistral-7b/
mistral-7b.json
hermes-7b/
hermes-7b.json
```
### Multiple quantizations
```sh
llama2-7b-gguf/ llama2-7b-gguf/
llama2-7b-gguf-Q2.json llama2-7b-gguf-Q2.json
llama2-7b-gguf-Q3_K_L.json llama2-7b-gguf-Q3_K_L.json
.bin .bin
```
### Multiple model partitions
```sh
llava-ggml/ llava-ggml/
llava-ggml-Q5.json llava-ggml-Q5.json
.proj .proj
ggml ggml
```
llama-70b-finetune ### ?? whats this example for?
```sh
llama-70b-finetune/
llama-70b-finetune-q5.json llama-70b-finetune-q5.json
.bin .bin
``` ```
## Jan API ## Jan API - TODO
### Jan Model API ### Jan Model API