Skip to content

Commit e79f8c8

Browse files
committed
add api.md and auth.md; rename clowder section
Signed-off-by: Avi Deitcher <avi@deitcher.net>
1 parent f67996d commit e79f8c8

File tree

5 files changed

+72
-8
lines changed

5 files changed

+72
-8
lines changed

docs/ainekko/index.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
---
2-
id: what-is-ainekko
3-
title: What Is Ainekko?
2+
id: who-is-ainekko
3+
title: Who Is Ainekko?
44
sidebar_position: 1
55
---
66

7-
What is Ainekko?
8-
97
Ainekko is a leading AI hardware and software provider.
108

119
Ainekko is the leading sponsor of [Clowder](/docs/clowder).

docs/clowder/api.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
id: clowder-api
3+
title: Clowder API
4+
sidebar_position: 9
5+
---
6+
7+
Clowder provides a RESTful API for interacting with the platform. The API allows you to manage models, deployments, and configurations, as well as perform inference on deployed models.
8+
9+
There are two distinct categories of API endpoints:
10+
11+
* Inference
12+
* Operational
13+
14+
## Inference API
15+
16+
The inference API is used to interact with deployed models and perform inference. It allows you to send queries to models and receive responses.
17+
18+
The inference API is compatible with the [OpenAI API](https://platform.openai.com/docs/api-reference/introduction) and supports the same endpoints and parameters. It also augments it with additional endpoints for usage with Clowder.
19+
20+
Inference API endpoints are used by end-users directly or by AI applications to interact with deployed models.
21+
22+
Read the official Clowder Inference API documentation for all of the endpoints.
23+
24+
## Operational API
25+
26+
The operational API is used to manage models, deployments, and configurations. It allows you to create, update, and delete models, deployments, and configurations, as well as retrieve information about them.
27+
28+
Operational API endpoints are used by administrators and developers to manage the Clowder platform.
29+
30+
Read the official Clowder Operational API documentation for all of the endpoints.
31+
32+

docs/clowder/authentication.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
id: clowder-auth
3+
title: Clowder Authentication
4+
sidebar_position: 10
5+
---
6+
7+
Requests to the Clowder API require authentication, in the form of a Bearer token.
8+
9+
As of this writing, the Bearer token is a static token, configured when you deploy Clowder. By default, it is `nekko-admin-token`.
10+
11+
Clowder is building support for multiple forms of authentication.

docs/clowder/web.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
id: clowder-web
3+
title: Clowder Web UI
4+
sidebar_position: 8
5+
---
6+
Clowder is a system for deploying, managing, and operating AI models.
7+
As such, its focus is on the backend of managing models, configurations, and deployments, and providing APIs for interacting with these models.
8+
These APIs usually are integrated into other systems, such as web applications or command-line interfaces (CLIs), rather than
9+
serving as a standalone user interface.
10+
11+
However, by default, Clowder does include the Open WebUI client app, a web-based user interface (UI) that allows users to interact with models.
12+
13+
The Open WebUI is exposed at port 4080 of the service `open-webui` in the `clowder` namespace.
14+
15+
You can expose it locally with:
16+
17+
```sh
18+
# Start this and leave it running in a separate terminal window.
19+
kubectl port-forward svc/open-webui 4080:4080
20+
```
21+
22+
Whether exposed locally or accessed directly in the cluster, open it in your browser, for example locally at [http://localhost:4080](http://localhost:4080).
23+
Open a browser to the address, select the model, and have a chat.

docusaurus.config.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,13 +82,13 @@ const config = {
8282
type: 'docSidebar',
8383
sidebarId: 'structureSidebar',
8484
position: 'left',
85-
label: 'What is Clowder?',
85+
label: 'Clowder Docs',
8686
},
8787
{
8888
type: 'docSidebar',
8989
sidebarId: 'guideSidebar',
9090
position: 'left',
91-
label: 'What is Ainekko?',
91+
label: 'Who is Ainekko?',
9292
},
9393
{
9494
type: 'docSidebar',
@@ -110,8 +110,8 @@ const config = {
110110
{
111111
title: 'Docs',
112112
items: [
113-
{ label: 'What is Clowder?', to: '/docs/clowder' },
114-
{ label: 'What is Ainekko?', to: '/docs/ainekko' },
113+
{ label: 'Clowder Docs', to: '/docs/clowder' },
114+
{ label: 'Who is Ainekko?', to: '/docs/ainekko' },
115115
{ label: 'Community', to: '/docs/community' },
116116
],
117117
},

0 commit comments

Comments
 (0)