Skip to content

Commit f9e0dfd

Browse files
authored
docs: Fix a few typos (#5988)
There are small typos in: - docs/source/contributing/developer_guide.md - docs/source/contributing/jupyter_style.md - pymc/step_methods/hmc/hmc.py - pymc/step_methods/hmc/nuts.py Fixes: - Should read `interpreted` rather than `interpreded`. - Should read `total` rather than `totall`. - Should read `personal` rather than `presonal`. Signed-off-by: Tim Gates <[email protected]>
1 parent 710aee3 commit f9e0dfd

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

docs/source/contributing/developer_guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ def logp(self, value):
151151
```
152152

153153
In the ``logp`` method, parameters and values are either Aesara tensors, or could be converted to tensors.
154-
It is rather convenient as the evaluation of logp is represented as a tensor (``RV.logpt``), and when we linked different ``logp`` together (e.g., summing all ``RVs.logpt`` to get the model totall logp) the dependence is taken care of by Aesara when the graph is built and compiled.
154+
It is rather convenient as the evaluation of logp is represented as a tensor (``RV.logpt``), and when we linked different ``logp`` together (e.g., summing all ``RVs.logpt`` to get the model total logp) the dependence is taken care of by Aesara when the graph is built and compiled.
155155
Again, since the compiled function depends on the nodes that already in the graph, whenever you want to generate a new function that takes new input tensors you either need to regenerate the graph with the appropriate dependencies, or replace the node by editing the existing graph.
156156
In PyMC we use the second approach by using ``aesara.clone_replace()`` when it is needed.
157157

docs/source/contributing/jupyter_style.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ This guide does not teach nor cover MyST extensively, only gives some opinionate
5353
* Above all, stay consistent with variable names within the notebook. Notebooks using multiple names for the same variable will not be merged.
5454
* Use meaningful variable names wherever possible. Our users come from different backgrounds and not everyone is familiar with the same naming conventions.
5555
- Annotate dimensions too. Notebooks are published to be read, so even if the shape is derived
56-
from the inputs or you don't like to use named dims and don't use them in your presonal
56+
from the inputs or you don't like to use named dims and don't use them in your personal
5757
code, notebooks must use dims, even if annotating and not setting the shape.
5858
It makes the code easier to follow, especially for newcomers.
5959
* Sometimes it makes sense to use Greek letters to refer to variables, for example when writing equations, as this makes them easier to read. In that case, use LaTeX to insert the Greek letter like this `$\theta$` instead of using Unicode like `θ`.

pymc/step_methods/hmc/hmc.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ def __init__(self, vars=None, path_length=2.0, max_steps=1024, **kwargs):
7777
scaling: array_like, ndim = {1,2}
7878
The inverse mass, or precision matrix. One dimensional arrays are
7979
interpreted as diagonal matrices. If `is_cov` is set to True,
80-
this will be interpreded as the mass or covariance matrix.
80+
this will be interpreted as the mass or covariance matrix.
8181
is_cov: bool, default=False
8282
Treat the scaling as mass or covariance matrix.
8383
potential: Potential, optional

pymc/step_methods/hmc/nuts.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ def __init__(self, vars=None, max_treedepth=10, early_max_treedepth=8, **kwargs)
158158
scaling: array_like, ndim = {1,2}
159159
The inverse mass, or precision matrix. One dimensional arrays are
160160
interpreted as diagonal matrices. If `is_cov` is set to True,
161-
this will be interpreded as the mass or covariance matrix.
161+
this will be interpreted as the mass or covariance matrix.
162162
is_cov: bool, default=False
163163
Treat the scaling as mass or covariance matrix.
164164
potential: Potential, optional

0 commit comments

Comments
 (0)