Skip to content

Commit

Permalink
Fix markdown list in docstring
Browse files Browse the repository at this point in the history
Trailing content is unindented, so the renderer reads the markdown list
as fragmented. Indent the enclosed content by 2 spaces. Also dedent
the lead sentences, so that there's less space to cover for trailing
content. Thus, they don't get picked up as code by some other renderers.
  • Loading branch information
abhro committed Nov 30, 2024
1 parent 78ad9c9 commit 5c6179f
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/helpers/losses.jl
Original file line number Diff line number Diff line change
Expand Up @@ -196,13 +196,13 @@ Binary Cross Entropy Loss with optional label smoothing and fused logit computat
Returns the binary cross entropy loss computed as:
- If `logits` is either `false` or `Val(false)`:
- If `logits` is either `false` or `Val(false)`:
$$\text{agg}\left(-\tilde{y} * \log\left(\hat{y} + \epsilon\right) - (1 - \tilde{y}) * \log\left(1 - \hat{y} + \epsilon\right)\right)$$
$$\text{agg}\left(-\tilde{y} * \log\left(\hat{y} + \epsilon\right) - (1 - \tilde{y}) * \log\left(1 - \hat{y} + \epsilon\right)\right)$$
- If `logits` is `true` or `Val(true)`:
- If `logits` is `true` or `Val(true)`:
$$\text{agg}\left((1 - \tilde{y}) * \hat{y} - log\sigma(\hat{y})\right)$$
$$\text{agg}\left((1 - \tilde{y}) * \hat{y} - log\sigma(\hat{y})\right)$$
The value of $\tilde{y}$ is computed using label smoothing. If `label_smoothing` is
`nothing`, then no label smoothing is applied. If `label_smoothing` is a real number
Expand Down

0 comments on commit 5c6179f

Please sign in to comment.