Skip to content

Commit 531088b

Browse files
committed
docs: add experimental tag
1 parent 0626c30 commit 531088b

11 files changed

Lines changed: 67 additions & 11 deletions

File tree

website/docs/guide/context/pages.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ raw.truncate_working_page_tokens(n); // drop the last n tokens within the wor
192192

193193
Working pages must be full (every slot written) before they can commit. Calling `commit_working_pages(k)` while the k-th page is still partial returns an error. Most code lets `flush()` decide when to commit; the manual form is for hand-written forward-pass loops.
194194

195-
For when to use these operations, see [Inputs: tokens, positions, masks](../forward/inputs).
195+
For when to use these operations, see [Tokens, positions, and masks](../forward/inputs).
196196

197197
## When pages get freed
198198

website/docs/guide/context/scheduling.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ import TabItem from '@theme/TabItem';
99

1010
# Scheduling and budgets
1111

12+
:::warning[Experimental]
13+
The credit auction and bidding API are a prototype. Interfaces, defaults, and capabilities change frequently.
14+
:::
15+
1216
Pie's engine schedules forward passes across all live processes via a per-step credit auction. Each context bids for compute on every tick, and the engine fills its batch by clearing the highest bids first. This page covers the bidding API. **Most inferlets do not need to touch it.** The default `Generator` auto-bids using a budget-exhausting strategy that spreads the wallet over the horizon. Read on if you want to write a custom bid strategy or understand what the default is doing. Read this after [Pages](./pages).
1317

1418
## Why credits

website/docs/guide/forward/adapters.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ import TabItem from '@theme/TabItem';
99

1010
# Adapters
1111

12+
:::warning[Experimental]
13+
Adapter support is a prototype. Interfaces, defaults, and capabilities change frequently.
14+
:::
15+
1216
LoRA adapters are runtime-managed overlays scoped to a model. The full lifecycle (create, open, fork, save, load, destroy) is available in all three SDKs. This page covers using an adapter at inference. Read this after [The forward pass](./overview).
1317

1418
:::note[Running on the dummy driver?]

website/docs/guide/forward/inputs.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: "Inputs: tokens, positions, masks"
2+
title: "Tokens, positions, and masks"
33
description: Drive the input side of a forward pass with tokens, custom positions, and BRLE attention masks
44
sidebar_position: 2
55
---
66

7-
# Inputs: tokens, positions, masks
7+
# Tokens, positions, and masks
88

99
A forward pass takes a list of input positions, the token IDs at those positions, and an optional attention mask. This page covers the three input modalities. Read this after [The forward pass](./overview).
1010

website/docs/guide/forward/overview.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,14 +113,14 @@ The handles are typed: `out.token(probe_handle)` does not compile. Mismatched ac
113113

114114
## What this section covers
115115

116-
- [Inputs: tokens, positions, masks](./inputs). Building the input side of a forward pass.
116+
- [Tokens, positions, and masks](./inputs). Building the input side of a forward pass.
117117
- [Samplers and probabilities](./samplers). Every `Sampler` kind and every `Probe` kind.
118118
- [Constrained generation](./constrained). Logit masks driven by JSON Schema, regex, EBNF, and custom grammars.
119119
- [Adapters](./adapters). LoRA adapters scoped to a model.
120120
- [Speculative decoding](./speculation). System speculation and the `Speculator` trait.
121121

122122
## Next
123123

124-
- [Inputs: tokens, positions, masks](./inputs).
124+
- [Tokens, positions, and masks](./inputs).
125125
- [Samplers and probabilities](./samplers).
126126
- [Generation overview](../decoder/overview): the layer that runs `forward()` in a loop for you.

website/docs/guide/io/mcp.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ import TabItem from '@theme/TabItem';
99

1010
# MCP
1111

12+
:::warning[Experimental]
13+
MCP support is a prototype. Interfaces, defaults, and capabilities change frequently.
14+
:::
15+
1216
The [Model Context Protocol](https://modelcontextprotocol.io/) is an open standard for exposing tools, resources, and prompt templates to LLM applications. Pie ships an MCP client. Inferlets discover and call MCP servers without writing transport code. Read this after [Tool-call parser](../decoder/tool-calling).
1317

1418
There are two sides to MCP in Pie:

website/docs/reference/bakery.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ description: Reference for the bakery CLI (scaffold, build, publish inferlets)
55

66
# Bakery
77

8+
:::warning[Experimental]
9+
Bakery is a prototype. Interfaces, defaults, and capabilities change frequently.
10+
:::
11+
812
`bakery` is the developer-side CLI for inferlets. It wraps the Cargo / npm build, talks to the Pie registry, and produces packaged WASM artifacts.
913

1014
For the end-to-end workflow narrative, see [Your first inferlet](../guide/first-inferlet) (build) and [Deploy and publish](../guide/deploy/serve) (publish). This page is the command reference.

website/docs/reference/drivers/sglang.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ sidebar_position: 5
66

77
# SGLang
88

9+
:::warning[Experimental]
10+
The SGLang driver is a prototype. Interfaces, defaults, and capabilities change frequently.
11+
:::
12+
913
`type = "sglang"`. A subprocess Python driver that delegates the forward pass to SGLang. Pie wraps SGLang's `ServerArgs`; field names match SGLang exactly, so values pass through unchanged.
1014

1115
Use this driver to run a model that the embedded [`cuda_native` and `dev`](./cuda) drivers do not yet implement, or to run against SGLang's attention kernels and its n-gram speculative decoding.

website/docs/reference/drivers/vllm.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ sidebar_position: 4
66

77
# vLLM
88

9+
:::warning[Experimental]
10+
The vLLM driver is a prototype. Interfaces, defaults, and capabilities change frequently.
11+
:::
12+
913
`type = "vllm"`. A subprocess Python driver that delegates the forward pass to vLLM. Pie wraps vLLM's `EngineArgs`; field names match vLLM exactly, so values pass through unchanged.
1014

1115
Use this driver to run a model that the embedded [`cuda_native` and `dev`](./cuda) drivers do not yet implement, or to run against vLLM's attention kernels.

website/sidebars.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ const sidebars: SidebarsConfig = {
6565
'guide/context/overview',
6666
'guide/context/pages',
6767
'guide/context/sharing',
68-
'guide/context/scheduling',
68+
{type: 'doc', id: 'guide/context/scheduling', className: 'sidebar-experimental'},
6969
],
7070
},
7171
{
@@ -77,8 +77,8 @@ const sidebars: SidebarsConfig = {
7777
'guide/forward/inputs',
7878
'guide/forward/samplers',
7979
'guide/forward/constrained',
80-
'guide/forward/adapters',
8180
'guide/forward/speculation',
81+
{type: 'doc', id: 'guide/forward/adapters', className: 'sidebar-experimental'},
8282
],
8383
},
8484
{
@@ -103,7 +103,7 @@ const sidebars: SidebarsConfig = {
103103
'guide/io/messaging',
104104
'guide/io/http',
105105
'guide/io/filesystem',
106-
'guide/io/mcp',
106+
{type: 'doc', id: 'guide/io/mcp', className: 'sidebar-experimental'},
107107
],
108108
},
109109
{
@@ -148,7 +148,7 @@ const sidebars: SidebarsConfig = {
148148
collapsed: false,
149149
items: [
150150
'reference/pie',
151-
'reference/bakery',
151+
{type: 'doc', id: 'reference/bakery', className: 'sidebar-experimental'},
152152
'reference/pie-client',
153153
],
154154
},
@@ -159,8 +159,8 @@ const sidebars: SidebarsConfig = {
159159
items: [
160160
'reference/drivers/cuda',
161161
'reference/drivers/portable',
162-
'reference/drivers/vllm',
163-
'reference/drivers/sglang',
162+
{type: 'doc', id: 'reference/drivers/vllm', className: 'sidebar-experimental'},
163+
{type: 'doc', id: 'reference/drivers/sglang', className: 'sidebar-experimental'},
164164
],
165165
},
166166
{

0 commit comments

Comments
 (0)