Commit b579c9a
authored
style: apply /style-guide pass to serverless-rl (#2667)
## Summary
This PR applies the `/style-guide` skill (Google Developer Style Guide +
CoreWeave conventions) to the `serverless-rl` section. The run was fully
automated; only style-level edits were made.
## Files edited
- `serverless-rl/api-reference.mdx`
- `serverless-rl/prerequisites.mdx`
- `serverless-rl/sft.mdx`
- `serverless-rl/sft/usage.mdx`
- `serverless-rl/usage-limits.mdx`
- `serverless-rl/usage.mdx`
- `serverless-rl/use-trained-models.mdx`
## Recommendations for technical review
### Prerequisites
- Confirm whether a brief link to `/serverless-rl/prerequisites` should
appear at the top of the Authentication section in `api-reference.mdx`,
not only under Related resources.
- In `prerequisites.mdx`, confirm whether the `ApiKeyCreate` snippet
covers W&B account sign-up, or whether a separate sign-up
link/instruction is needed so the page is self-contained.
- In `sft.mdx`, verify whether ART-specific prerequisites (Python
version, OpenPipe account, ART package install) belong on the page or in
the linked prerequisites doc.
- In `sft/usage.mdx`, consider adding a Prerequisites section listing
the required W&B account, access to Serverless Inference, Models,
Artifacts, optional Weave, and the ART library so the page is
self-contained.
- In `usage.mdx`, confirm whether tutorial-style inline prerequisites
should be present per CoreWeave tutorial guidelines, rather than only
linking out.
- In `use-trained-models.mdx`, consider a labeled Prerequisites section
covering a completed training run, a known saved step, and any
IAM/permissions scope required on the W&B API key; also introduce
`WANDB_API_KEY` before its first use in the cURL example.
- Across pages, confirm that key terms (Serverless RL, LoRA, LoRA
adapter, checkpoint, base model, trajectory, reward function,
post-train, ART framework) are defined on linked prerequisite pages or
add short inline definitions/links.
### Verification steps
- In `api-reference.mdx`, consider a short cURL example against `GET
/v1/health` or `GET /v1/system-check` so readers can confirm credentials
work.
- In `prerequisites.mdx`, consider a verification cue confirming the API
key works and the project was created before "Next steps."
- In `sft/usage.mdx`, confirm whether a brief "what you'll have
accomplished" / expected-outcome sentence is appropriate after training
completes (e.g., a deployed LoRA available via Serverless Inference and
stored as an artifact).
- In `usage.mdx`, consider adding an in-doc "what success looks like"
statement after the linked ART quickstart.
- In `use-trained-models.mdx`, add a short "expected result" note after
each example (response shape, status, or how to confirm the model is
serving).
### Technical accuracy
- **`api-reference.mdx`** — `/v1/chat/completions` and
`/v1/chat/completions/` both link to "Create Chat Completion" (slugs
`create-chat-completion-1` and `create-chat-completion`); likely a
duplicate from the OpenAPI spec — needs SME input on whether one should
be hidden.
- **`api-reference.mdx`** — Auto-generated bullet titles render as
"Create Sft Training Job" / "Create Rl Training Job"; should be "Create
SFT Training Job" / "Create RL Training Job" (upstream OpenAPI fix).
- **`api-reference.mdx`** — The bullet for `POST
/v1/preview/models/{model_id}/log` is just "Log", which is ambiguous;
the OpenAPI summary should be clarified.
- **`api-reference.mdx`** — Endpoint paths mix `/v1/...` (health, chat)
with `/v1/preview/...` (models, training-jobs); consider whether
"preview" status should be called out.
- **`prerequisites.mdx`** — Confirm the link
`https://docs.wandb.ai/models/track/project-page` is the canonical
"Projects guide" URL (path suggests "Project page," which may not match
the displayed link text). Also confirm `/serverless-rl/api-reference`
resolves to the intended destination.
- **`prerequisites.mdx` (line 6)** — "Serverless RL **currently**
supports the following foundation models for training." Confirm intent:
a list as of publication (remove "currently") or a live catalog (remove
as redundant with the auto-generation note).
- **`sft.mdx`** — Confirm
`https://art.openpipe.ai/fundamentals/sft-training` is the canonical,
current Serverless SFT entry point, and that
`https://art.openpipe.ai/getting-started/about` is the correct ART
"about" landing.
- **`sft/usage.mdx`** — "Save them locally or to a third party for
backup" — "third party" is vague; name supported options or link to a
reference.
- **`usage-limits.mdx`** — Verify "Training is free during the public
preview period" (line 20) is still accurate and plan how the page should
be updated when the preview ends.
- **`usage-limits.mdx`** — Confirm the 2,000 / 6,000 concurrency numbers
(line 30) are current, and that `support@wandb.com` is still the right
contact for limit-increase requests.
- **`usage-limits.mdx`** — Verify the "5 GB / ~30 LoRAs" model-storage
estimate (line 24) is current.
- **`usage.mdx`** — Verify the Google Colab notebook URL
(`openpipe/art-notebooks/.../2048/2048.ipynb`) still resolves to the
intended 2048 example. Confirm whether "Serverless RL" should remain as
a product name or get a formal first-use expansion ("Serverless
reinforcement learning (RL)").
- **`use-trained-models.mdx`** — Slash inconsistency in
`wandb-artifact://` scheme: the cURL example (line 41) uses
`wandb-artifact://[ENTITY]/...` (two slashes), while the schema (line
16) and Python example (line 66) use `wandb-artifact:///` (three
slashes). Confirm the accepted form and standardize.
- **`use-trained-models.mdx`** — Step prefix ambiguity: schema uses
`:step25`, Python uses `:step100`, cURL uses `[STEP]` without clarifying
whether `step` is part of the value. Confirm and document.
- **`use-trained-models.mdx` (line 21)** — "Your W&B entity's (team)
name" reads awkwardly; confirm whether "entity" and "team" are
synonymous in this context and rephrase consistently.
### Missing content
- **`api-reference.mdx`** — No mention of rate limits, pagination, error
response format, versioning policy, or SDKs/client libraries; the
"OpenAI-compatible" claim for chat completions isn't elaborated (which
OpenAI client configurations work and any deviations).
- **`prerequisites.mdx`** — Clarify whether `mailto:support@wandb.ai` is
for (a) requesting unlisted models, (b) requesting access/onboarding for
listed models, or (c) both. Consider a brief legend explaining "Type,"
"Context Window," and "Parameters" (especially `Active-Total` MoE
notation). The HTML comment about auto-generation is invisible to
readers — consider a visible "Last updated" or "Source" note.
- **`prerequisites.mdx` ("Create a project in W&B")** — Consider noting
whether the project name must match anything referenced later in ART or
API configuration, and whether the section should be an explicit
single-step procedure or merged with the API-key step.
- **`prerequisites.mdx` ("Next steps")** — Only two items; consider
additional follow-on resources (tutorial, examples repo,
pricing/limits).
- **`sft.mdx`** — Indicate which models or model families are supported
via Serverless SFT and any scale/quota considerations distinct from
Serverless RL; add a brief statement of how Serverless SFT relates to
Serverless RL for readers landing from search.
- **`sft/usage.mdx`** — Consider a high-level overview of the workflow
(what the user does in ART, what comes back into W&B) so readers know
what they're committing to before leaving the page. Define or link
"checkpoint" on first use.
- **`usage-limits.mdx`** — Geographic restrictions bullet (line 32)
links to the Terms of Service without indicating whether an in-docs list
of supported/unsupported regions exists; add one if available. Consider
whether `429` concurrency-limit behavior warrants a `<Note>` or
`<Warning>` callout rather than inline prose.
- **`usage.mdx`** — No "Resources" or "Related" section; if more
references are added later (Colab notebooks, API reference, blog posts),
consider reintroducing it, provided the inline links in the intro are
restructured to avoid duplication. "Post-train" and "ART framework" are
referenced without on-page definition (ART is linked; "post-train" may
warrant a glossary or concept link).
- **`use-trained-models.mdx`** — No mention of how to find the entity,
project, model name, or step values from the W&B UI or API; link to the
relevant reference. Consider adding a parent H2 (such as "Make an
inference request") with the two examples as H3 children, plus
procedural subheadings ("Construct the endpoint", "Send a request") for
scannability. Standardize the Python example to bracket-style uppercase
placeholders so both examples teach the same naming convention.
## How to review
- Each file's changes are style edits only. Compare side-by-side and
flag any that change technical meaning.
- Approve and merge to accept the edits, or close to reject them.1 parent d033e71 commit b579c9a
7 files changed
Lines changed: 66 additions & 49 deletions
File tree
- serverless-rl
- sft
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
| 4 | + | |
4 | 5 | | |
5 | 6 | | |
6 | 7 | | |
7 | | - | |
| 8 | + | |
8 | 9 | | |
9 | 10 | | |
| 11 | + | |
| 12 | + | |
10 | 13 | | |
11 | 14 | | |
12 | 15 | | |
13 | 16 | | |
14 | 17 | | |
15 | 18 | | |
16 | | - | |
| 19 | + | |
17 | 20 | | |
18 | 21 | | |
19 | 22 | | |
20 | 23 | | |
21 | 24 | | |
22 | | - | |
| 25 | + | |
23 | 26 | | |
24 | 27 | | |
25 | 28 | | |
26 | 29 | | |
27 | 30 | | |
| 31 | + | |
28 | 32 | | |
29 | | - | |
| 33 | + | |
30 | 34 | | |
31 | 35 | | |
32 | 36 | | |
33 | 37 | | |
34 | | - | |
| 38 | + | |
35 | 39 | | |
36 | 40 | | |
37 | 41 | | |
38 | 42 | | |
39 | 43 | | |
40 | 44 | | |
41 | 45 | | |
42 | | - | |
| 46 | + | |
43 | 47 | | |
44 | 48 | | |
45 | 49 | | |
46 | 50 | | |
47 | 51 | | |
48 | 52 | | |
49 | | - | |
| 53 | + | |
50 | 54 | | |
51 | 55 | | |
52 | 56 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
| 4 | + | |
4 | 5 | | |
5 | 6 | | |
6 | 7 | | |
| |||
13 | 14 | | |
14 | 15 | | |
15 | 16 | | |
16 | | - | |
| 17 | + | |
17 | 18 | | |
18 | 19 | | |
19 | 20 | | |
20 | 21 | | |
21 | 22 | | |
22 | | - | |
| 23 | + | |
23 | 24 | | |
24 | 25 | | |
25 | 26 | | |
26 | | - | |
| 27 | + | |
27 | 28 | | |
28 | | - | |
29 | | - | |
| 29 | + | |
| 30 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
| 4 | + | |
4 | 5 | | |
5 | 6 | | |
6 | | - | |
| 7 | + | |
7 | 8 | | |
8 | | - | |
9 | | - | |
10 | | - | |
11 | | - | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
12 | 13 | | |
13 | 14 | | |
14 | 15 | | |
15 | | - | |
| 16 | + | |
16 | 17 | | |
17 | | - | |
| 18 | + | |
18 | 19 | | |
19 | 20 | | |
20 | 21 | | |
21 | | - | |
22 | | - | |
23 | | - | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
24 | 25 | | |
25 | 26 | | |
26 | 27 | | |
27 | 28 | | |
28 | 29 | | |
29 | | - | |
30 | | - | |
31 | | - | |
32 | | - | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
33 | 34 | | |
34 | | - | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
| 4 | + | |
4 | 5 | | |
5 | 6 | | |
6 | | - | |
| 7 | + | |
7 | 8 | | |
8 | | - | |
9 | | - | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
| 4 | + | |
4 | 5 | | |
5 | 6 | | |
| 7 | + | |
| 8 | + | |
6 | 9 | | |
7 | 10 | | |
8 | | - | |
| 11 | + | |
9 | 12 | | |
10 | 13 | | |
11 | 14 | | |
12 | | - | |
| 15 | + | |
13 | 16 | | |
14 | 17 | | |
15 | 18 | | |
| |||
19 | 22 | | |
20 | 23 | | |
21 | 24 | | |
22 | | - | |
| 25 | + | |
23 | 26 | | |
24 | 27 | | |
25 | 28 | | |
26 | | - | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
27 | 32 | | |
28 | 33 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
| 4 | + | |
4 | 5 | | |
5 | 6 | | |
6 | 7 | | |
7 | 8 | | |
8 | | - | |
9 | | - | |
10 | | - | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
| 4 | + | |
4 | 5 | | |
5 | 6 | | |
6 | | - | |
| 7 | + | |
7 | 8 | | |
8 | | - | |
| 9 | + | |
9 | 10 | | |
10 | 11 | | |
11 | 12 | | |
12 | 13 | | |
13 | 14 | | |
14 | 15 | | |
15 | | - | |
16 | | - | |
| 16 | + | |
| 17 | + | |
17 | 18 | | |
18 | 19 | | |
19 | 20 | | |
20 | 21 | | |
21 | 22 | | |
22 | 23 | | |
23 | 24 | | |
24 | | - | |
| 25 | + | |
25 | 26 | | |
26 | | - | |
| 27 | + | |
27 | 28 | | |
28 | | - | |
| 29 | + | |
29 | 30 | | |
30 | 31 | | |
31 | 32 | | |
32 | | - | |
| 33 | + | |
33 | 34 | | |
34 | | - | |
| 35 | + | |
35 | 36 | | |
36 | | - | |
| 37 | + | |
37 | 38 | | |
38 | 39 | | |
39 | 40 | | |
40 | 41 | | |
41 | | - | |
| 42 | + | |
42 | 43 | | |
43 | 44 | | |
44 | 45 | | |
| |||
48 | 49 | | |
49 | 50 | | |
50 | 51 | | |
51 | | - | |
| 52 | + | |
52 | 53 | | |
53 | 54 | | |
54 | 55 | | |
| |||
0 commit comments