Skip to content

Commit

Permalink
docs: rename image file and format documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
0xHieu01 committed Feb 16, 2024
1 parent 8366964 commit e7722e4
Show file tree
Hide file tree
Showing 8 changed files with 8 additions and 9 deletions.
11 changes: 5 additions & 6 deletions docs/docs/guides/05-using-server/01-start-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,23 +23,23 @@ Navigate by clicking the `Local API Server` icon on the left side of your screen

<br></br>

![local-api-view](./assets/local-api-view.png)
![01-local-api-view](./assets/01-local-api-view.png)

## Choose your model

On the top right of your screen under `Model Settings`, set the LLM that your local server will be running. You can choose from any of the models already installed, or pick a new model by clicking `Explore the Hub`.
On the top right of your screen under `Model Settings`, set the LLM that your local server will be running. You can choose from any of the models already installed, or pick a new model by clicking `Explore the Hub`.

<br></br>

![choose-model](./assets/choose-model.png)
![01-choose-model](./assets/01-choose-model.png)

## Set your Server Options

On the left side of your screen you can set custom server options.

<br></br>

![server-settings](./assets/server-settings.png)
![01-server-settings](./assets/01-server-settings.png)

### Local Server Address

Expand All @@ -65,7 +65,6 @@ Click the `Start Server` button on the top left of your screen. You will see the

<br></br>

![running-server](./assets/running-server.png)
![01-running-server](./assets/01-running-server.png)

Your server is now running. Next, learn how to use your local API server.

6 changes: 3 additions & 3 deletions docs/docs/guides/05-using-server/02-using-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ On the top left of your screen below the red `Stop Server` button is the blue `A

<br></br>

![api-reference](./assets/api-reference.png)
![02-api-reference](./assets/02-api-reference.png)

Scroll through the various available endpoints to learn what options are available.

Expand All @@ -34,7 +34,7 @@ In the Chat section of the API reference, you will see an example JSON request b

<br></br>

![chat-example](./assets/chat-example.png)
![02-chat-example](./assets/02-chat-example.png)

With your local server running, you can click the `Try it out` button on the top left, then the blue `Execute` button below the JSON. The browser will send the example request to your server, and display the response body below.

Expand Down Expand Up @@ -100,4 +100,4 @@ curl -X 'POST' \
"total_tokens": 533
}
}
```
```

0 comments on commit e7722e4

Please sign in to comment.