Skip to content

Commit c005493

Browse files
committed
docs: initialize site
Signed-off-by: rudeigerc <rudeigerc@gmail.com>
1 parent 47a898e commit c005493

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+332
-13
lines changed
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

site/.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/public
2+
resources/
3+
node_modules/
4+
package-lock.json
5+
.hugo_build.lock
File renamed without changes.

site/assets/scss/_styles_project.scss

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
a {
2+
text-decoration: none;
3+
}
4+
5+
.td-box--white {
6+
a {
7+
color: $primary !important;
8+
}
9+
}
+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/*
2+
Add styles or override variables from the theme here.
3+
*/
4+
5+
// Theme colors
6+
$primary: #EE4C1E;
7+
$secondary: #FFFFFF;
8+
9+
$link-color: #EE4C1E;

site/content/en/_index.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: llmaz
3+
---
4+
5+
{{< blocks/cover color="primary" image_anchor="top" height="max" >}}
6+
<p><img class="w-50 h-auto mb-4" src="/images/logo.png" class="llmaz-logo" /></p>
7+
<a class="btn btn-lg btn-secondary me-3 mb-4" href="/docs/">
8+
Learn More <i class="fas fa-arrow-alt-circle-right ms-2"></i>
9+
</a>
10+
<a class="btn btn-lg btn-secondary me-3 mb-4" href="https://github.com/InftyAI/llmaz">
11+
GitHub <i class="fab fa-github ms-2 "></i>
12+
</a>
13+
<p class="lead mt-5 -text-white">Easy, advanced inference platform for large language models on Kubernetes</p>
14+
{{< blocks/link-down color="white" >}}
15+
16+
{{< /blocks/cover >}}
17+
18+
19+
{{% blocks/section color="white" type="row" %}}
20+
21+
<p class="h1 text-center mb-4">Key Features</p>
22+
23+
{{% blocks/feature icon="fas fa-user-shield" title="Easy of Use" %}}
24+
People can quick deploy a LLM service with minimal configurations.
25+
{{% /blocks/feature %}}
26+
27+
{{% blocks/feature icon="fas fa-cogs" title="Broad Backends Support" %}}
28+
llmaz supports a wide range of advanced inference backends for different scenarios, like <a href="https://github.com/vllm-project/vllm">vLLM</a>, <a href="https://github.com/huggingface/text-generation-inference">Text-Generation-Inference</a>, <a href="https://github.com/sgl-project/sglang">SGLang</a>, <a href="https://github.com/ggerganov/llama.cpp">llama.cpp</a>. Find the full list of supported backends <a href="/InftyAI/llmaz/blob/main/docs/support-backends.md">here</a>.
29+
{{% /blocks/feature %}}
30+
31+
{{% blocks/feature icon="fas fa-exchange-alt" title="Accelerator Fungibility" %}}
32+
llmaz supports serving the same LLM with various accelerators to optimize cost and performance.
33+
{{% /blocks/feature %}}
34+
35+
{{% blocks/feature icon="fas fa-warehouse" title="Various Model Providers" %}}
36+
llmaz supports a wide range of model providers, such as <a href="https://huggingface.co/" rel="nofollow">HuggingFace</a>, <a href="https://www.modelscope.cn" rel="nofollow">ModelScope</a>, ObjectStores. llmaz will automatically handle the model loading, requiring no effort from users.
37+
{{% /blocks/feature %}}
38+
39+
{{% blocks/feature icon="fas fa-network-wired" title="Multi-Host Support" %}}
40+
llmaz supports both single-host and multi-host scenarios with <a href="https://github.com/kubernetes-sigs/lws">LWS</a> from day 0.
41+
{{% /blocks/feature %}}
42+
43+
{{% blocks/feature icon="fas fa-door-open" title="AI Gateway Support" %}}
44+
Offering capabilities like token-based rate limiting, model routing with the integration of <a href="https://aigateway.envoyproxy.io/" rel="nofollow">Envoy AI Gateway</a>.
45+
{{% /blocks/feature %}}
46+
47+
{{% blocks/feature icon="fas fa-comments" title="Build-in ChatUI" %}}
48+
Out-of-the-box chatbot support with the integration of <a href="https://github.com/open-webui/open-webui">Open WebUI</a>, offering capacities like function call, RAG, web search and more, see configurations <a href="/InftyAI/llmaz/blob/main/docs/open-webui.md">here</a>.
49+
{{% /blocks/feature %}}
50+
51+
{{% blocks/feature icon="fas fa-expand-arrows-alt" title="Scaling Efficiency" %}}
52+
llmaz supports horizontal scaling with <a href="/InftyAI/llmaz/blob/main/docs/examples/hpa/README.md">HPA</a> by default and will integrate with autoscaling components like <a href="https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler">Cluster-Autoscaler</a> or <a href="https://github.com/kubernetes-sigs/karpenter">Karpenter</a> for smart scaling across different clouds.
53+
{{% /blocks/feature %}}
54+
55+
{{% blocks/feature icon="fas fa-box-open" title="Efficient Model Distribution (WIP)" %}}
56+
Out-of-the-box model cache system support with <a href="https://github.com/InftyAI/Manta">Manta</a>, still under development right now with architecture reframing.
57+
{{% /blocks/feature %}}
58+
59+
{{% /blocks/section %}}

site/content/en/docs/_index.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: Documentation
3+
linkTitle: Documentation
4+
menu: {main: {weight: 20}}
5+
---

docs/develop.md renamed to site/content/en/docs/develop.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
# Develop Guidance
2-
3-
A develop guidance for people who want to learn more about this project.
1+
---
2+
title: Develop Guidance
3+
weight: 3
4+
description: >
5+
This section contains a develop guidance for people who want to learn more about this project.
6+
---
47

58
## Project Structure
69

@@ -22,4 +25,4 @@ See the [API Reference](./reference/core.v1alpha1.md) for more details.
2225

2326
### Inference APIs
2427

25-
See the [API Reference](./reference/inference.v1alpha1.md) for more details.
28+
See the [API Reference](./reference/inference.v1alpha1.md) for more details.

docs/installation.md renamed to site/content/en/docs/installation.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# Installation Guide
1+
---
2+
title: Installation
3+
weight: 1
4+
description: >
5+
This section introduces the installation guidance for llmaz.
6+
---
7+
28

39
## Prerequisites
410

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Integrations
3+
weight: 2
4+
description: >
5+
This section contains the llmaz integration information.
6+
---

docs/envoy-ai-gateway.md renamed to site/content/en/docs/integrations/envoy-ai-gateway.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Envoy AI Gateway
1+
---
2+
title: Envoy AI Gateway
3+
weight: 1
4+
---
25

36
[Envoy AI Gateway](https://aigateway.envoyproxy.io/) is an open source project for using Envoy Gateway
47
to handle request traffic from application clients to Generative AI services.

docs/open-webui.md renamed to site/content/en/docs/integrations/open-webui.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Open-WebUI
1+
---
2+
title: Open WebUI
3+
weight: 2
4+
---
25

36
[Open WebUI](https://github.com/open-webui/open-webui) is a user-friendly AI interface with OpenAI-compatible APIs, serving as the default chatbot for llmaz.
47

docs/prometheus-operator/README.md renamed to site/content/en/docs/integrations/prometheus-operator.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
1-
# Install Prometheus Operator Guide
1+
---
2+
title: Prometheus Operator
3+
weight: 3
4+
---
25

36
Currently, llmaz has already integrated metrics. This document provides deployment steps explaining how to install and configure Prometheus Operator in a Kubernetes cluster.
47

58
### Install the prometheus operator
69

7-
Please follow the [documentation](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/getting-started/installation.md) to install
10+
Please follow the [documentation](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/getting-started/installation.md) to install
811

912
```bash
1013
# Installing the prometheus operator
@@ -14,9 +17,9 @@ prometheus-operator-55b5c96cf8-jl2nx 1/1 Running 0 12s
1417
```
1518
Ensure that the Prometheus Operator Pod is running successfully.
1619

17-
### Install the ServiceMonitor CR for llmaz
20+
### Install the ServiceMonitor CR for llmaz
1821

19-
To enable monitoring for the llmaz system, you need to install the ServiceMonitor custom resource (CR).
22+
To enable monitoring for the llmaz system, you need to install the ServiceMonitor custom resource (CR).
2023
You can either modify the Helm chart prometheus according to the [documentation](./../../chart/values.global.yaml) or use `make install-prometheus` in Makefile.
2124

2225
- Using Helm Chart: to modify the values.global.yaml
@@ -73,4 +76,4 @@ Forwarding from 0.0.0.0:9090 -> 9090
7376
If using kind, we can use port-forward, `kubectl port-forward services/prometheus-operated 39090:9090 --address 0.0.0.0 -n llmaz-system`
7477
This allows us to access prometheus using a browser: `http://localhost:9090/query`
7578

76-
![prometheus](prometheus.png?raw=true)
79+
![prometheus](/images/prometheus.png?raw=true)

docs/support-backends.md renamed to site/content/en/docs/integrations/support-backends.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# All Kinds of Supported Inference Backends
1+
---
2+
title: Supported Inference Backends
3+
weight: 4
4+
---
25

36
If you want to integrate more backends into llmaz, please refer to this [PR](https://github.com/InftyAI/llmaz/pull/182). It's always welcomed.
47

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Reference
3+
weight: 4
4+
description: >
5+
This section contains the llmaz reference information.
6+
menu:
7+
main:
8+
weight: 30
9+
---

site/content/en/search.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Search Results
3+
layout: search
4+
---

site/go.mod

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
module github.com/InftyAI/llmaz/site
2+
3+
go 1.23
4+
5+
require github.com/google/docsy v0.11.0 // indirect

site/go.sum

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
github.com/FortAwesome/Font-Awesome v0.0.0-20240716171331-37eff7fa00de/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
2+
github.com/google/docsy v0.11.0 h1:QnV40cc28QwS++kP9qINtrIv4hlASruhC/K3FqkHAmM=
3+
github.com/google/docsy v0.11.0/go.mod h1:hGGW0OjNuG5ZbH5JRtALY3yvN8ybbEP/v2iaK4bwOUI=
4+
github.com/twbs/bootstrap v5.3.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=

site/hugo.toml

+169
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
baseURL = "https://llmaz.inftyai.com/"
2+
title = "llmaz"
3+
4+
# Language settings
5+
contentDir = "content/en"
6+
defaultContentLanguage = "en"
7+
defaultContentLanguageInSubdir = false
8+
# Useful when translating.
9+
enableMissingTranslationPlaceholders = true
10+
11+
enableRobotsTXT = true
12+
13+
# Will give values to .Lastmod etc.
14+
enableGitInfo = true
15+
16+
# Comment out to disable taxonomies in Docsy
17+
disableKinds = ["taxonomy"]
18+
19+
# Highlighting config
20+
pygmentsCodeFences = true
21+
pygmentsUseClasses = false
22+
# Use the new Chroma Go highlighter in Hugo.
23+
pygmentsUseClassic = false
24+
#pygmentsOptions = "linenos=table"
25+
# See https://help.farbox.com/pygments.html
26+
pygmentsStyle = "tango"
27+
28+
# Configure how URLs look like per section.
29+
[permalinks]
30+
blog = "/:section/:year/:month/:day/:slug/"
31+
32+
# Image processing configuration.
33+
[imaging]
34+
resampleFilter = "CatmullRom"
35+
quality = 75
36+
anchor = "Smart"
37+
38+
# [services]
39+
# [services.googleAnalytics]
40+
# id = ""
41+
42+
# Language configuration
43+
44+
[languages]
45+
[languages.en]
46+
languageName ="English"
47+
title = "llmaz"
48+
[languages.en.params]
49+
description = "Easy, advanced inference platform for large language models on Kubernetes."
50+
51+
[markup]
52+
[markup.goldmark]
53+
[markup.goldmark.parser.attribute]
54+
block = true
55+
[markup.goldmark.renderer]
56+
unsafe = true
57+
[markup.highlight]
58+
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
59+
style = "tango"
60+
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
61+
# guessSyntax = "true"
62+
63+
# Comment out if you don't want the "print entire section" link enabled.
64+
[outputs]
65+
section = ["HTML", "print", "RSS"]
66+
67+
# Everything below this are Site Params
68+
69+
[params]
70+
# First one is picked as the Twitter card image if not set on page.
71+
# images = ["images/project-illustration.png"]
72+
73+
# Menu title if your navbar has a versions selector to access old versions of your site.
74+
# This menu appears only if you have at least one [params.versions] set.
75+
version_menu = "Releases"
76+
77+
# Flag used in the "version-banner" partial to decide whether to display a
78+
# banner on every page indicating that this is an archived version of the docs.
79+
# Set this flag to "true" if you want to display the banner.
80+
archived_version = false
81+
82+
# The version number for the version of the docs represented in this doc set.
83+
# Used in the "version-banner" partial to display a version number for the
84+
# current doc set.
85+
version = "v0.1.3"
86+
87+
# A link to latest version of the docs. Used in the "version-banner" partial to
88+
# point people to the main doc site.
89+
url_latest_version = "https://example.com"
90+
91+
# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
92+
github_repo = "https://github.com/InftyAI/llmaz"
93+
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
94+
github_project_repo = "https://github.com/InftyAI/llmaz"
95+
96+
# Specify a value here if your content directory is not in your repo's root directory
97+
github_subdir = "site"
98+
99+
# Uncomment this if your GitHub repo does not have "main" as the default branch,
100+
# or specify a new value if you want to reference another branch in your GitHub links
101+
github_branch= "main"
102+
103+
# Google Custom Search Engine ID. Remove or comment out to disable search.
104+
# gcs_engine_id = "d72aa9b2712488cc3"
105+
106+
# Enable Lunr.js offline search
107+
offlineSearch = true
108+
109+
# Enable syntax highlighting and copy buttons on code blocks with Prism
110+
prism_syntax_highlighting = false
111+
112+
copyright = "The InftyAI Team"
113+
114+
# User interface configuration
115+
[params.ui]
116+
# Set to true to disable breadcrumb navigation.
117+
breadcrumb_disable = false
118+
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar
119+
navbar_logo = true
120+
# Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage.
121+
navbar_translucent_over_cover_disable = false
122+
# Enable to show the side bar menu in its compact state.
123+
sidebar_menu_compact = false
124+
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
125+
sidebar_search_disable = true
126+
127+
# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
128+
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
129+
# If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
130+
# add "hide_feedback: true" to the page's front matter.
131+
[params.ui.feedback]
132+
enable = true
133+
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
134+
yes = 'Glad to hear it! Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
135+
no = 'Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
136+
137+
# Adds a reading time to the top of each doc.
138+
# If you want this feature, but occasionally need to remove the Reading time from a single page,
139+
# add "hide_readingtime: true" to the page's front matter
140+
[params.ui.readingtime]
141+
enable = true
142+
143+
[params.links]
144+
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
145+
[[params.links.user]]
146+
name ="Twitter"
147+
url = "https://x.com/InftyAI"
148+
icon = "fab fa-x-twitter"
149+
desc = "Follow us on Twitter to get the latest news!"
150+
# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
151+
[[params.links.developer]]
152+
name = "GitHub"
153+
url = "https://github.com/InftyAI/llmaz"
154+
icon = "fab fa-github"
155+
desc = "Github repository"
156+
[[params.links.developer]]
157+
name = "Slack"
158+
url = "https://inftyai.slack.com/"
159+
icon = "fab fa-slack"
160+
desc = "Chat with other developers"
161+
162+
# hugo module configuration
163+
[module]
164+
[module.hugoVersion]
165+
extended = true
166+
min = "0.110.0"
167+
[[module.imports]]
168+
path = "github.com/google/docsy"
169+
disable = false

site/layouts/404.html

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{{ define "main" -}}
2+
<div class="td-content">
3+
<h1>Not found</h1>
4+
<p>Oops! This page doesn't exist. Try going back to the <a href="{{ "" | relURL }}">home page</a>.</p>
5+
</div>
6+
{{- end }}

0 commit comments

Comments
 (0)