Skip to content

Commit ac578ee

Browse files
committed
fix index.md formart
Signed-off-by: guangli.bao <[email protected]>
1 parent 094fc93 commit ac578ee

File tree

4 files changed

+31
-74
lines changed

4 files changed

+31
-74
lines changed

docs/developer/index.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,30 +10,26 @@ GuideLLM is an open-source project that values community contributions. We maint
1010

1111
## Developer Resources
1212

13-
<div class="grid cards" markdown>
14-
15-
- :material-handshake:{ .lg .middle } Code of Conduct
13+
- 📝 Code of Conduct
1614

1715
______________________________________________________________________
1816

1917
Our community guidelines ensure that participation in the GuideLLM project is a positive, inclusive, and respectful experience for everyone.
2018

21-
[:octicons-arrow-right-24: Code of Conduct](code-of-conduct.md)
19+
[Code of Conduct](code-of-conduct.md)
2220

23-
- :material-source-pull:{ .lg .middle } Contributing Guide
21+
- 🔖 Contributing Guide
2422

2523
______________________________________________________________________
2624

2725
Learn how to effectively contribute to GuideLLM, including reporting bugs, suggesting features, improving documentation, and submitting code.
2826

29-
[:octicons-arrow-right-24: Contributing Guide](contributing.md)
27+
[Contributing Guide](contributing.md)
3028

31-
- :material-tools:{ .lg .middle } Development Guide
29+
- 📚 Development Guide
3230

3331
______________________________________________________________________
3432

3533
Detailed instructions for setting up your development environment, implementing changes, and adhering to the project's coding standards and best practices.
3634

37-
[:octicons-arrow-right-24: Development Guide](developing.md)
38-
39-
</div>
35+
[Development Guide](developing.md)

docs/getting-started/index.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,38 +12,34 @@ GuideLLM makes it simple to evaluate and optimize your large language model depl
1212

1313
Follow the guides below in sequence to get the most out of GuideLLM and optimize your LLM deployments for production use.
1414

15-
<div class="grid cards" markdown>
16-
17-
- :material-package-variant:{ .lg .middle } Installation
15+
- 🛠 Installation
1816

1917
______________________________________________________________________
2018

2119
Learn how to install GuideLLM using pip, from source, or with specific version requirements.
2220

23-
[:octicons-arrow-right-24: Installation Guide](install.md)
21+
[Installation Guide](install.md)
2422

25-
- :material-server:{ .lg .middle } Start a Server
23+
- 🚀 Start a Server
2624

2725
______________________________________________________________________
2826

2927
Set up an OpenAI-compatible server using vLLM or other supported backends to benchmark your LLM deployments.
3028

31-
[:octicons-arrow-right-24: Server Setup Guide](server.md)
29+
[Server Setup Guide](server.md)
3230

33-
- :material-speedometer:{ .lg .middle } Run Benchmarks
31+
- Run Benchmarks
3432

3533
______________________________________________________________________
3634

3735
Learn how to configure and run performance benchmarks against your LLM server under various load conditions.
3836

39-
[:octicons-arrow-right-24: Benchmarking Guide](benchmark.md)
37+
[Benchmarking Guide](benchmark.md)
4038

41-
- :material-chart-bar:{ .lg .middle } Analyze Results
39+
- 📊 Analyze Results
4240

4341
______________________________________________________________________
4442

4543
Interpret benchmark results to understand throughput, latency, reliability, and optimize your deployments.
4644

47-
[:octicons-arrow-right-24: Analysis Guide](analyze.md)
48-
49-
</div>
45+
[Analysis Guide](analyze.md)

docs/guides/index.md

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,54 +10,50 @@ Whether you're interested in understanding the system architecture, exploring su
1010

1111
## Key Guides
1212

13-
<div class="grid cards" markdown>
14-
15-
- :material-layers-outline:{ .lg .middle } Architecture
13+
- 🏗️ Architecture
1614

1715
______________________________________________________________________
1816

1917
Understanding the modular design of GuideLLM and how core components interact to evaluate LLM deployments.
2018

21-
[:octicons-arrow-right-24: Architecture Overview](architecture.md)
19+
[Architecture Overview](architecture.md)
2220

23-
- :material-server:{ .lg .middle } Backends
21+
- 🖥️ Backends
2422

2523
______________________________________________________________________
2624

2725
Learn about supported LLM backends and how to set up OpenAI-compatible servers for benchmarking.
2826

29-
[:octicons-arrow-right-24: Backend Guide](backends.md)
27+
[Backend Guide](backends.md)
3028

31-
- :material-database:{ .lg .middle } Datasets
29+
- 🗄️ Datasets
3230

3331
______________________________________________________________________
3432

3533
Configure and use different data sources for benchmarking, including synthetic data, Hugging Face datasets, and file-based options.
3634

37-
[:octicons-arrow-right-24: Dataset Guide](datasets.md)
35+
[Dataset Guide](datasets.md)
3836

39-
- :material-chart-bar:{ .lg .middle } Metrics
37+
- 📊 Metrics
4038

4139
______________________________________________________________________
4240

4341
Explore the comprehensive metrics provided by GuideLLM to evaluate performance, including latency, throughput, and token-level analysis.
4442

45-
[:octicons-arrow-right-24: Metrics Guide](metrics.md)
43+
[Metrics Guide](metrics.md)
4644

47-
- :material-file-export:{ .lg .middle } Outputs
45+
- 📄 Outputs
4846

4947
______________________________________________________________________
5048

5149
Learn about supported output formats and how to customize result reporting for your benchmarks.
5250

53-
[:octicons-arrow-right-24: Output Guide](outputs.md)
51+
[Output Guide](outputs.md)
5452

55-
- :material-target:{ .lg .middle } Service Level Objectives
53+
- 🎯 Service Level Objectives
5654

5755
______________________________________________________________________
5856

5957
Define and implement SLOs and SLAs for your LLM deployments to ensure reliability and performance.
6058

61-
[:octicons-arrow-right-24: SLO Guide](service_level_objectives.md)
62-
63-
</div>
59+
[SLO Guide](service_level_objectives.md)

docs/index.md

Lines changed: 5 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
# Home
22

33
<p align="center">
4-
<picture>
5-
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/neuralmagic/guidellm/main/docs/assets/guidellm-logo-light.png">
6-
<img alt="GuideLLM Logo" src="https://raw.githubusercontent.com/neuralmagic/guidellm/main/docs/assets/guidellm-logo-dark.png" width=55%>
7-
</picture>
4+
<img alt="GuideLLM Logo" src="https://raw.githubusercontent.com/neuralmagic/guidellm/main/docs/assets/guidellm-logo-dark.png" width="55%">
85
</p>
96

107
<h3 align="center">
@@ -23,38 +20,10 @@ SLO-Aware Benchmarking and Evaluation Platform for Optimizing Real-World LLM Inf
2320

2421
## Key Sections
2522

26-
<div class="grid cards" markdown>
23+
- 🚀 Getting Started Install GuideLLM, set up your first benchmark, and analyze the results to optimize your LLM deployment. [Getting started](./getting-started/)
2724

28-
- :material-rocket-launch:{ .lg .middle } Getting Started
25+
- 📚 Guides Detailed guides covering backends, datasets, metrics, and service level objectives for effective LLM benchmarking. [Guides](./guides/)
2926

30-
______________________________________________________________________
27+
- 💻 Examples Step-by-step examples demonstrating real-world benchmarking scenarios and optimization techniques. [Examples](./examples/)
3128

32-
Install GuideLLM, set up your first benchmark, and analyze the results to optimize your LLM deployment.
33-
34-
[:octicons-arrow-right-24: Getting started](./getting-started/)
35-
36-
- :material-book-open-variant:{ .lg .middle } Guides
37-
38-
______________________________________________________________________
39-
40-
Detailed guides covering backends, datasets, metrics, and service level objectives for effective LLM benchmarking.
41-
42-
[:octicons-arrow-right-24: Guides](./guides/)
43-
44-
- :material-code-tags:{ .lg .middle } Examples
45-
46-
______________________________________________________________________
47-
48-
Step-by-step examples demonstrating real-world benchmarking scenarios and optimization techniques.
49-
50-
[:octicons-arrow-right-24: Examples](./examples/)
51-
52-
- :material-api:{ .lg .middle } API Reference
53-
54-
______________________________________________________________________
55-
56-
Complete reference documentation for the GuideLLM API to integrate benchmarking into your workflow.
57-
58-
[:octicons-arrow-right-24: API Reference](./api/)
59-
60-
</div>
29+
- 🔌 API Reference Complete reference documentation for the GuideLLM API to integrate benchmarking into your workflow. [API Reference](./api/)

0 commit comments

Comments
 (0)