Skip to content

Commit e294a31

Browse files
authored
docs: Add initial fern docs (#676)
1 parent 314bd83 commit e294a31

File tree

102 files changed

+3321
-898
lines changed

Some content is hidden

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

102 files changed

+3321
-898
lines changed

.cursor/skills/docs-to-fern/SKILL_md

Lines changed: 972 additions & 0 deletions
Large diffs are not rendered by default.

docs/api/synthesis.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
<!--
1+
---
22
# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
33
# SPDX-License-Identifier: Apache-2.0
4-
-->
4+
sidebar-title: Prefix Synthesis API Reference
5+
---
56
# Prefix Synthesis API Reference
67

78
Complete API documentation for the prefix synthesis module.
@@ -556,4 +557,4 @@ except ValueError as e:
556557
## See Also
557558

558559
- [Prefix Synthesis Tutorial](../tutorials/prefix-synthesis.md)
559-
- [Trace Replay](../benchmark_modes/trace_replay.md)
560+
- [Trace Replay](../benchmark-modes/trace-replay.md)

docs/architecture.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
<!--
2-
SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3-
SPDX-License-Identifier: Apache-2.0
4-
-->
1+
---
2+
# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3+
# SPDX-License-Identifier: Apache-2.0
4+
sidebar-title: Architecture of AIPerf
5+
---
56

67
# Architecture of AIPerf
78

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
<!--
2-
SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3-
SPDX-License-Identifier: Apache-2.0
4-
-->
1+
---
2+
# SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3+
# SPDX-License-Identifier: Apache-2.0
4+
sidebar-title: Benchmark Datasets
5+
---
56

67
This document describes datasets that AIPerf can use to generate stimulus. Additional support is under development, so check back often.
78

@@ -39,12 +40,12 @@ This document describes datasets that AIPerf can use to generate stimulus. Addit
3940
<tr>
4041
<td><strong>Mooncake</strong></td>
4142
<td style="text-align: center;">✅</td>
42-
<td>Mooncake trace file <a href="benchmark_modes/trace_replay.md"><code>--input-file your_trace_file.jsonl --custom-dataset-type mooncake_trace</code></a></td>
43+
<td>Mooncake trace file <a href="benchmark-modes/trace-replay.md"><code>--input-file your_trace_file.jsonl --custom-dataset-type mooncake_trace</code></a></td>
4344
</tr>
4445
<tr>
4546
<td><strong>ShareGPT</strong></td>
4647
<td style="text-align: center;">✅</td>
47-
<td>Conversations from <a href="https://huggingface.co/datasets/anon8231489123/ShareGPT_Vicuna_unfiltered/resolve/main/ShareGPT_V3_unfiltered_cleaned_split.json"><code>--public-dataset sharegpt</code></td>
48+
<td>Conversations from <a href="https://huggingface.co/datasets/anon8231489123/ShareGPT_Vicuna_unfiltered/resolve/main/ShareGPT_V3_unfiltered_cleaned_split.json"><code>--public-dataset sharegpt</code></a></td>
4849
</tr>
4950
</tbody>
5051
</table>

docs/benchmark_modes/timing-modes-reference.md renamed to docs/benchmark-modes/timing-modes-reference.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
<!--
1+
---
22
# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
33
# SPDX-License-Identifier: Apache-2.0
4-
-->
4+
sidebar-title: Load Generator Options Reference
5+
---
56
# Load Generator Options Reference
67

78
This guide provides a comprehensive reference for all load generator CLI options in AIPerf, including a compatibility matrix showing which options work together.
Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
<!--
2-
SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3-
SPDX-License-Identifier: Apache-2.0
4-
-->
1+
---
2+
# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3+
# SPDX-License-Identifier: Apache-2.0
4+
sidebar-title: Trace Replay with Mooncake Traces
5+
---
56

67
# Trace Replay with Mooncake Traces
78

@@ -61,18 +62,18 @@ Example entry:
6162

6263
Create a trace file with timing information:
6364

64-
<!-- aiperf-run-vllm-default-openai-endpoint-server -->
65+
{/* aiperf-run-vllm-default-openai-endpoint-server */}
6566
```bash
6667
cat > custom_trace.jsonl << 'EOF'
6768
{"timestamp": 0, "input_length": 1200, "output_length": 52, "hash_ids": [0, 1, 2]}
6869
{"timestamp": 105, "input_length": 1800, "output_length": 26, "hash_ids": [0, 3, 4, 5]}
6970
{"timestamp": 274, "input_length": 1300, "output_length": 52, "hash_ids": [1, 4, 6]}
7071
EOF
7172
```
72-
<!-- /aiperf-run-vllm-default-openai-endpoint-server -->
73+
{/* /aiperf-run-vllm-default-openai-endpoint-server */}
7374
Run AIPerf with the trace file:
7475

75-
<!-- aiperf-run-vllm-default-openai-endpoint-server -->
76+
{/* aiperf-run-vllm-default-openai-endpoint-server */}
7677
```bash
7778
aiperf profile \
7879
--model Qwen/Qwen3-0.6B \
@@ -83,7 +84,7 @@ aiperf profile \
8384
--custom-dataset-type mooncake_trace \
8485
--fixed-schedule
8586
```
86-
<!-- /aiperf-run-vllm-default-openai-endpoint-server -->
87+
{/* /aiperf-run-vllm-default-openai-endpoint-server */}
8788

8889
The `--fixed-schedule` flag tells AIPerf to send requests at the exact timestamps specified in the trace. This reproduces the original timing pattern.
8990

@@ -114,7 +115,7 @@ The `tools` field is only valid when `messages` is provided. It is injected dire
114115

115116
For real-world benchmarking, use the FAST25 production trace data from the Mooncake research paper:
116117

117-
<!-- aiperf-run-vllm-default-openai-endpoint-server -->
118+
{/* aiperf-run-vllm-default-openai-endpoint-server */}
118119
```bash
119120
# Download the Mooncake trace data
120121
curl -Lo mooncake_trace.jsonl https://raw.githubusercontent.com/kvcache-ai/Mooncake/refs/heads/main/FAST25-release/arxiv-trace/mooncake_trace.jsonl
@@ -132,4 +133,4 @@ aiperf profile \
132133
--custom-dataset-type mooncake_trace \
133134
--fixed-schedule
134135
```
135-
<!-- /aiperf-run-vllm-default-openai-endpoint-server -->
136+
{/* /aiperf-run-vllm-default-openai-endpoint-server */}

0 commit comments

Comments
 (0)