Skip to content

Commit 1f2ae35

Browse files
committed
docs(training): avoid an RST section underline in the DSpark loss docstring
The docs are built with MyST, where a line of dashes under text is a setext H2. The generated apidocs page for this module therefore started at H2 and tripped "Document headings start at H2, not H1 [myst.header]", which fails the docs build because it treats warnings as errors. Use bold text instead; this was the only RST underline under src/megatron/bridge. Signed-off-by: khazic <khazzz1c@gmail.com>
1 parent ba130f5 commit 1f2ae35

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

  • src/megatron/bridge/training/post_training/dspark

‎src/megatron/bridge/training/post_training/dspark/loss.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@
2828
Acceptance is measured analytically as ``accept_rate = 1 - 0.5 * L1`` and the
2929
expected accepted prefix length of a block as ``tau = sum_k cumprod(accept_rate)_k + 1``.
3030
31-
Return contract
32-
---------------
31+
**Return contract**
32+
3333
:func:`dspark_loss` returns the Megatron-Core 3-tuple ``(loss, num_tokens,
3434
report)``, matching :func:`megatron.bridge.training.losses.masked_next_token_loss`:
3535

0 commit comments

Comments
 (0)