From 04cdfa0ddab92d781003de1848425ec75338360f Mon Sep 17 00:00:00 2001 From: tikikun Date: Tue, 28 Nov 2023 11:02:42 +0700 Subject: [PATCH 1/4] chore: clarification changes to the model settings and model parameters --- docs/docs/specs/models.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/docs/specs/models.md b/docs/docs/specs/models.md index f9ea26724..b7fc8ffe9 100644 --- a/docs/docs/specs/models.md +++ b/docs/docs/specs/models.md @@ -70,11 +70,14 @@ Here's a standard example `model.json` for a GGUF model. "n_parallel": "4", }, "parameters": { // Models are called parameters + "stream": "true", + "model": "gpt-3.5-turbo", + "max_tokens": "2048", + "stop": [""], // This usually can be left blank, only used with specific need from model author + "frequency_penalty": "0", + "presence_penalty": "0", "temperature": "0.7", - "token_limit": "2048", - "top_k": "0", - "top_p": "1", - "stream": "true" + "top_p": "0.95" }, "metadata": {}, // Defaults to {} "assets": [ // Defaults to current dir @@ -82,6 +85,10 @@ Here's a standard example `model.json` for a GGUF model. ] ``` +The model settings in the example can be found at: (Nitro's model settings)[https://nitro.jan.ai/features/load-unload#table-of-parameters] + +The model paramemters in the example can be found at: (Nitro's model parameters)[https://nitro.jan.ai/api-reference#tag/Chat-Completion] + ## API Reference Jan's Model API is compatible with [OpenAI's Models API](https://platform.openai.com/docs/api-reference/models), with additional methods for managing and running models locally. From 190717d4d0471c0433ca7865d1d4c8dde3e9f2e2 Mon Sep 17 00:00:00 2001 From: automaticcat Date: Wed, 29 Nov 2023 16:34:59 +0700 Subject: [PATCH 2/4] fix link issue models.md --- docs/docs/specs/models.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/specs/models.md b/docs/docs/specs/models.md index b7fc8ffe9..0f63ea46e 100644 --- a/docs/docs/specs/models.md +++ b/docs/docs/specs/models.md @@ -85,9 +85,9 @@ Here's a standard example `model.json` for a GGUF model. ] ``` -The model settings in the example can be found at: (Nitro's model settings)[https://nitro.jan.ai/features/load-unload#table-of-parameters] +The model settings in the example can be found at: [Nitro's model settings](https://nitro.jan.ai/features/load-unload#table-of-parameters) -The model paramemters in the example can be found at: (Nitro's model parameters)[https://nitro.jan.ai/api-reference#tag/Chat-Completion] +The model paramemters in the example can be found at: [Nitro's model parameters](https://nitro.jan.ai/api-reference#tag/Chat-Completion) ## API Reference From 3ac807415509524af93868afac8d71411d9c5a60 Mon Sep 17 00:00:00 2001 From: automaticcat Date: Wed, 29 Nov 2023 16:37:27 +0700 Subject: [PATCH 3/4] spelling issue --- docs/docs/specs/models.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/specs/models.md b/docs/docs/specs/models.md index 0f63ea46e..287c1e551 100644 --- a/docs/docs/specs/models.md +++ b/docs/docs/specs/models.md @@ -87,7 +87,7 @@ Here's a standard example `model.json` for a GGUF model. The model settings in the example can be found at: [Nitro's model settings](https://nitro.jan.ai/features/load-unload#table-of-parameters) -The model paramemters in the example can be found at: [Nitro's model parameters](https://nitro.jan.ai/api-reference#tag/Chat-Completion) +The model parameters in the example can be found at: [Nitro's model parameters](https://nitro.jan.ai/api-reference#tag/Chat-Completion) ## API Reference From 0513f7f05edfd155ac57d0b6483bbc0217b0b708 Mon Sep 17 00:00:00 2001 From: automaticcat Date: Wed, 29 Nov 2023 16:41:20 +0700 Subject: [PATCH 4/4] fix data types issues in models.md --- docs/docs/specs/models.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/docs/docs/specs/models.md b/docs/docs/specs/models.md index 287c1e551..ce33e0505 100644 --- a/docs/docs/specs/models.md +++ b/docs/docs/specs/models.md @@ -64,20 +64,19 @@ Here's a standard example `model.json` for a GGUF model. "state": enum[null, "downloading", "ready", "starting", "stopping", ...] "format": "ggufv3", // Defaults to "ggufv3" "settings": { // Models are initialized with settings - "ctx_len": "2048", - "ngl": "100", - "embedding": "true", - "n_parallel": "4", + "ctx_len": 2048, + "ngl": 100, + "embedding": true, + "n_parallel": 4, }, "parameters": { // Models are called parameters - "stream": "true", - "model": "gpt-3.5-turbo", - "max_tokens": "2048", + "stream": true, + "max_tokens": 2048, "stop": [""], // This usually can be left blank, only used with specific need from model author - "frequency_penalty": "0", - "presence_penalty": "0", - "temperature": "0.7", - "top_p": "0.95" + "frequency_penalty": 0, + "presence_penalty": 0, + "temperature": 0.7, + "top_p": 0.95 }, "metadata": {}, // Defaults to {} "assets": [ // Defaults to current dir