Skip to content
This repository was archived by the owner on Jul 4, 2025. It is now read-only.

Commit 763b3a3

Browse files
authored
Merge pull request #167 from janhq/docs-update-0.1.14
Docs update hotfix
2 parents 9dbe4e6 + 397f86a commit 763b3a3

File tree

7 files changed

+25
-17
lines changed

7 files changed

+25
-17
lines changed

docs/docs/features/embed.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,4 +89,4 @@ The example response used the output from model [llama2 Chat 7B Q5 (GGUF)](https
8989

9090
</div>
9191

92-
The embedding feature in Nitro demonstrates a high level of compatibility with OpenAI, simplifying the transition between using OpenAI and local AI models. For more detailed information and advanced use cases, refer to the comprehensive [API Reference](https://nitro.jan.ai/api-reference)).
92+
The embedding feature in Nitro demonstrates a high level of compatibility with OpenAI, simplifying the transition between using OpenAI and local AI models. For more detailed information and advanced use cases, refer to the comprehensive [API Reference](https://nitro.jan.ai/api-reference).

docs/docs/features/prompt.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Nitro enables developers to configure dialogs and implement advanced prompt engi
2222

2323
To illustrate, let's create a "Pirate assistant":
2424

25-
> NOTE: "ai_prompt" and "user_prompt" are prefixes indicating the role. Configure them based on your model.
25+
> NOTE: "ai_prompt", "user_prompt" and "system_prompt" are prefixes indicating the role. Configure them based on your model.
2626
2727
### Prompt Configuration
2828

@@ -33,6 +33,7 @@ curl http://localhost:3928/inferences/llamacpp/loadmodel \
3333
"ctx_len": 128,
3434
"ngl": 100,
3535
"pre_prompt": "You are a Pirate. Using drunk language with a lot of Arr...",
36+
"system_prompt": "ASSISTANT'S RULE: ",
3637
"user_prompt": "USER:",
3738
"ai_prompt": "ASSISTANT: "
3839
}'

docs/docs/new/about.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,3 +119,7 @@ Nitro welcomes contributions in various forms, not just coding. Here are some wa
119119

120120
- [drogon](https://github.com/drogonframework/drogon): The fast C++ web framework
121121
- [llama.cpp](https://github.com/ggerganov/llama.cpp): Inference of LLaMA model in pure C/C++
122+
123+
## FAQ
124+
:::info COMING SOON
125+
:::

docs/docs/new/architecture.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ title: Architecture
44

55
![Nitro Architecture](img/architecture.drawio.png)
66

7-
### Details element example
8-
97
## Key Concepts
108

119
## Inference Server

docs/docs/new/quickstart.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,16 @@ title: Quickstart
77
### For Linux and MacOS
88

99
Open your terminal and enter the following command. This will download and install Nitro on your system.
10-
11-
```bash
12-
curl -sfL https://raw.githubusercontent.com/janhq/nitro/main/install.sh -o /tmp/install.sh && chmod +x /tmp/install.sh && sudo bash /tmp/install.sh --gpu && rm /tmp/install.sh
13-
```
10+
```bash
11+
curl -sfL https://raw.githubusercontent.com/janhq/nitro/main/install.sh | sudo /bin/bash -
12+
```
1413

1514
### For Windows
1615

1716
Open PowerShell and execute the following command. This will perform the same actions as for Linux and MacOS but is tailored for Windows.
18-
19-
```bash
20-
powershell -Command "& { Invoke-WebRequest -Uri 'https://raw.githubusercontent.com/janhq/nitro/main/install.bat' -OutFile 'install.bat'; .\install.bat --gpu; Remove-Item -Path 'install.bat' }"
21-
```
17+
```bash
18+
powershell -Command "& { Invoke-WebRequest -Uri 'https://raw.githubusercontent.com/janhq/nitro/main/install.bat' -OutFile 'install.bat'; .\install.bat; Remove-Item -Path 'install.bat' }"
19+
```
2220

2321
> **NOTE:**Installing Nitro will add new files and configurations to your system to enable it to run.
2422

docs/openapi/NitroAPI.yaml

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ paths:
167167
operationId: createChatCompletion
168168
tags:
169169
- Chat Completion
170-
summary: Create an chat with the model.
170+
summary: Create a chat with the model.
171171
requestBody:
172172
content:
173173
application/json:
@@ -544,23 +544,23 @@ components:
544544
stream:
545545
type: boolean
546546
default: true
547-
description: Enables continuous output generation, allowing for streaming of model responses.
547+
description: Enables continuous output generation, allowing for streaming of model responses
548548
model:
549549
type: string
550550
example: "gpt-3.5-turbo"
551-
description: Specifies the model being used for inference or processing tasks.
551+
description: Specifies the model being used for inference or processing tasks
552552
max_tokens:
553553
type: number
554554
default: 2048
555555
description: The maximum number of tokens the model will generate in a single response
556556
stop:
557557
type: arrays
558558
example: ["hello"]
559-
description: Defines specific tokens or phrases at which the model will stop generating further output.
559+
description: Defines specific tokens or phrases at which the model will stop generating further output
560560
frequency_penalty:
561561
type: number
562562
default: 0
563-
description: Adjusts the likelihood of the model repeating words or phrases in its output.
563+
description: Adjusts the likelihood of the model repeating words or phrases in its output
564564
presence_penalty:
565565
type: number
566566
default: 0
@@ -571,6 +571,12 @@ components:
571571
min: 0
572572
max: 1
573573
description: Controls the randomness of the model's output
574+
top_p:
575+
type: number
576+
default: 0.95
577+
min: 0
578+
max: 1
579+
description: Set probability threshold for more relevant outputs
574580

575581
ChatCompletionResponse:
576582
type: object

docs/openapi/OpenAIAPI.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9869,3 +9869,4 @@ x-oaiMeta:
98699869
- type: endpoint
98709870
key: createEdit
98719871
path: create
9872+

0 commit comments

Comments
 (0)