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

Commit d4e699d

Browse files
committed
update docs
1 parent 808d233 commit d4e699d

File tree

4 files changed

+39
-11
lines changed

4 files changed

+39
-11
lines changed

docs/docs/demos/chatbox-vid.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
title: Run local chatbox under 1 minute on MacOS with Nitro
3+
---

docs/docs/examples/chatbox.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,18 @@ Open your command line tool and enter:
2323
nitro
2424
```
2525

26-
> Ensure you are using the latest version of [Nitro](new/install.md)
26+
2. Download Model
2727

28-
2. Run the Model
28+
Use these commands to download and save the [Llama2 7B chat model](https://huggingface.co/TheBloke/Llama-2-7B-Chat-GGUF/tree/main):
29+
30+
```bash
31+
mkdir model && cd model
32+
wget -O llama-2-7b-model.gguf https://huggingface.co/TheBloke/Llama-2-7B-Chat-GGUF/resolve/main/llama-2-7b-chat.Q5_K_M.gguf?download=true
33+
```
34+
35+
> For more GGUF model, please look at [The Bloke](https://huggingface.co/TheBloke).
36+
37+
3. Run the Model
2938

3039
To load the model, use the following command:
3140

@@ -39,13 +48,11 @@ curl http://localhost:3928/inferences/llamacpp/loadmodel \
3948
}'
4049
```
4150

42-
3. Config chatbox
51+
4. Config chatbox
4352
Adjust the `settings` in Chatbox to connect with Nitro. Change your settings to match the configuration shown in the image below:
4453

4554
![Settings](img/chatbox.PNG)
4655

47-
4. Chat with the Model
48-
49-
Once the setup is complete, you can start chatting with the model using Chatbox. All functions of Chatbox are now enabled with Nitro as the backend.
56+
5. Chat with the Model
5057

51-
## Video demo
58+
Once the setup is complete, you can start chatting with the model using Chatbox. All functions of Chatbox are now enabled with Nitro as the backend.

docs/docs/new/build-source.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,13 +72,13 @@ Time to build Nitro!
7272
- **On Linux:**
7373

7474
```bash
75-
make -j $(%NUMBER_OF_PROCESSORS%)
75+
make -j $(nproc)
7676
```
7777

7878
- **On Windows:**
7979

8080
```bash
81-
cmake --build . --config Release
81+
make -j $(%NUMBER_OF_PROCESSORS%)
8282
```
8383

8484
## Start process

docs/sidebars.js

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,19 @@ const sidebars = {
3333
{
3434
type: "category",
3535
label: "Features",
36+
collapsible: false,
37+
collapsed: false,
3638
link: { type: "doc", id: "features/feat" },
3739
items: [
3840
"features/chat",
3941
"features/embed",
42+
],
43+
},
44+
{
45+
type: "category",
46+
label: "Advanced Features",
47+
link: { type: "doc", id: "features/feat" },
48+
items: [
4049
"features/multi-thread",
4150
"features/cont-batch",
4251
"features/load-unload",
@@ -46,7 +55,7 @@ const sidebars = {
4655
},
4756
{
4857
type: "category",
49-
label: "Guides",
58+
label: "Integrations",
5059
collapsible: false,
5160
collapsed: false,
5261
items: [
@@ -62,7 +71,16 @@ const sidebars = {
6271
// collapsed: false,
6372
// items: [{ type: "doc", id: "new/architecture", label: "Architecture" }],
6473
// },
65-
"new/faq"
74+
"new/faq",
75+
{
76+
type: "category",
77+
label: "Demos",
78+
collapsible: true,
79+
collapsed: true,
80+
items: [
81+
"demos/chatbox-vid",
82+
],
83+
},
6684
],
6785

6886
apiSidebar: [

0 commit comments

Comments
 (0)