Skip to content

docs: update Markdown equation elements #13966

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 4 commits into from
Aug 6, 2026
Merged

docs: update Markdown equation elements #13966

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3a6b2fe
docs: update Markdown equation SVGs
stdlib-bot Aug 6, 2026
797b75b
docs: update Markdown equation elements
stdlib-bot Aug 6, 2026
b65bed8
Discard changes to lib/node_modules/@stdlib/ml/base/loss/float64/hing…
kgryte Aug 6, 2026
40ee91a
docs: fix equation
kgryte Aug 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/blas/ext/base/dwxdy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ This BLAS extension implements the operation
```

<!-- <div class="equation" align="center" data-raw-text="\mathbf{w} = \mathbf{x} \oslash \mathbf{y}" data-equation="eq:wxdy">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@e72895028e08bd5faa19a580deaf380c3ff38e42/lib/node_modules/@stdlib/blas/ext/base/dwxdy/docs/img/equation_wxdy.svg" alt="Equation for wxdy operation.">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@b51ebff8a15e9d9cf8d9bb64d569d709f45fc994/lib/node_modules/@stdlib/blas/ext/base/dwxdy/docs/img/equation_wxdy.svg" alt="Equation for wxdy operation.">
<br>
</div> -->

Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/blas/ext/base/swxdy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ This BLAS extension implements the operation
```

<!-- <div class="equation" align="center" data-raw-text="\mathbf{w} = \mathbf{x} \oslash \mathbf{y}" data-equation="eq:wxdy">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@e72895028e08bd5faa19a580deaf380c3ff38e42/lib/node_modules/@stdlib/blas/ext/base/swxdy/docs/img/equation_wxdy.svg" alt="Equation for wxdy operation.">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@b51ebff8a15e9d9cf8d9bb64d569d709f45fc994/lib/node_modules/@stdlib/blas/ext/base/swxdy/docs/img/equation_wxdy.svg" alt="Equation for wxdy operation.">
<br>
</div> -->

Expand Down
5 changes: 5 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/expf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@ The natural [exponential function][exponential-function] is defined as
y = e^x
```

<!-- <div class="equation" align="center" data-raw-text="y = e^x" data-equation="eq:natural_exponential_function">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@3a6b2fe467c920a88f281944d6eb9370eb5cc4cb/lib/node_modules/@stdlib/math/base/special/expf/docs/img/equation_natural_exponential_function.svg" alt="Natural exponential function definition">
<br>
</div> -->

<!-- </equation> -->

where `e` is [Euler's][@stdlib/constants/float32/e] number.
Expand Down
17 changes: 17 additions & 0 deletions ...tdlib/math/base/special/expf/docs/img/equation_natural_exponential_function.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 7 additions & 2 deletions lib/node_modules/@stdlib/ml/base/loss/float64/hinge-gradient/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,17 @@ limitations under the License.

The [hinge loss gradient][hinge-loss-gradient] is defined as

<!-- <equation class="equation" label="eq:hinge_loss_gradient" align="center" raw="\frac{\partial \ell}{\partial w_i} = \begin{cases} -yx_i & \text{if } yp \leq t \\ 0 & \text{otherwise} \end{cases}" alt="Equation for the hinge loss gradient."> -->
<!-- <equation class="equation" label="eq:hinge_loss_gradient" align="center" raw="\frac{\partial \ell}{\partial w} = \begin{cases} -yx & \text{if } yp \leq t \\ 0 & \text{otherwise} \end{cases}" alt="Equation for the hinge loss gradient."> -->

```math
\frac{\partial \ell}{\partial w_i} = \begin{cases} -yx_i & \text{if } yp \leq t \\ 0 & \text{otherwise} \end{cases}
\frac{\partial \ell}{\partial w} = \begin{cases} -yx & \text{if } yp \leq t \\ 0 & \text{otherwise} \end{cases}
```

<!-- <div class="equation" align="center" data-raw-text="\frac{\partial \ell}{\partial w} = \begin{cases} -yx &amp; \text{if } yp \leq t \\ 0 &amp; \text{otherwise} \end{cases}" data-equation="eq:hinge_loss_gradient">
<img src="" alt="Equation for the hinge loss gradient.">
<br>
</div> -->

<!-- </equation> -->

</section>
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/ml/base/loss/float64/squared-hinge-gradient/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The [squared hinge loss gradient][squared-hinge-loss-gradient] is defined as
```

<!-- <div class="equation" align="center" data-raw-text="\frac{\partial \ell}{\partial w} = \begin{cases} -2y(t - yp)x &amp; \text{if } yp \leq t \\ 0 &amp; \text{otherwise} \end{cases}" data-equation="eq:squared_hinge_loss_gradient">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@e72895028e08bd5faa19a580deaf380c3ff38e42/lib/node_modules/@stdlib/ml/base/loss/float64/squared-hinge-gradient/docs/img/equation_squared_hinge_loss_gradient.svg" alt="Equation for the squared hinge loss gradient.">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@b51ebff8a15e9d9cf8d9bb64d569d709f45fc994/lib/node_modules/@stdlib/ml/base/loss/float64/squared-hinge-gradient/docs/img/equation_squared_hinge_loss_gradient.svg" alt="Equation for the squared hinge loss gradient.">
<br>
</div> -->

Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/incr/nanmrmse/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ For a window of size `W`, the [**root mean squared error**][root-mean-squared-er
```

<!-- <div class="equation" align="center" data-raw-text="\operatorname{RMSE} = \sqrt{ \frac{1}{W} \sum_{i=0}^{W-1} (y_i - x_i)^2 }" data-equation="eq:root_mean_squared_error">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@e72895028e08bd5faa19a580deaf380c3ff38e42/lib/node_modules/@stdlib/stats/incr/nanmrmse/docs/img/equation_root_mean_squared_error.svg" alt="Equation for the root mean squared error.">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@b51ebff8a15e9d9cf8d9bb64d569d709f45fc994/lib/node_modules/@stdlib/stats/incr/nanmrmse/docs/img/equation_root_mean_squared_error.svg" alt="Equation for the root mean squared error.">
<br>
</div> -->

Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/incr/nanmvariance/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ s^2 = \frac{1}{W-1} \sum_{i=0}^{W-1} ( x_i - \bar{x} )^2
```

<!-- <div class="equation" align="center" data-raw-text="s^2 = \frac{1}{W-1} \sum_{i=0}^{W-1} ( x_i - \bar{x} )^2" data-equation="eq:unbiased_sample_variance">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@e72895028e08bd5faa19a580deaf380c3ff38e42/lib/node_modules/@stdlib/stats/incr/nanmvariance/docs/img/equation_unbiased_sample_variance.svg" alt="Equation for the unbiased sample variance.">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@b51ebff8a15e9d9cf8d9bb64d569d709f45fc994/lib/node_modules/@stdlib/stats/incr/nanmvariance/docs/img/equation_unbiased_sample_variance.svg" alt="Equation for the unbiased sample variance.">
<br>
</div> -->

Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/incr/nanwmean/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The [weighted arithmetic mean][weighted-arithmetic-mean] is defined as
```

<!-- <div class="equation" align="center" data-raw-text="\bar{x} = \frac{\displaystyle\sum_{i=0}^{n-1} w_{i} x_{i}}{\displaystyle\sum_{i=0}^{n-1} w_{i}}" data-equation="eq:weighted_arithmetic_mean">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@e72895028e08bd5faa19a580deaf380c3ff38e42/lib/node_modules/@stdlib/stats/incr/nanwmean/docs/img/equation_weighted_arithmetic_mean.svg" alt="Equation for the weighted arithmetic mean.">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@b51ebff8a15e9d9cf8d9bb64d569d709f45fc994/lib/node_modules/@stdlib/stats/incr/nanwmean/docs/img/equation_weighted_arithmetic_mean.svg" alt="Equation for the weighted arithmetic mean.">
<br>
</div> -->

Expand Down