Skip to content

Commit 8f4ad70

Browse files
Armavicavandalt
authored andcommitted
Fix single backticks for code
1 parent 1dbcb4b commit 8f4ad70

File tree

5 files changed

+14
-14
lines changed

5 files changed

+14
-14
lines changed

docs/source/api.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ Plots, stats and diagnostics are delegated to the
4141
library, a general purpose library for
4242
"exploratory analysis of Bayesian models".
4343

44-
* Functions from the `arviz.plots` module are available through ``pymc.<function>`` or ``pymc.plots.<function>``,
44+
* Functions from the ``arviz.plots`` module are available through ``pymc.<function>`` or ``pymc.plots.<function>``,
4545
but for their API documentation please refer to the :ref:`ArviZ documentation <arviz:plot_api>`.
4646

47-
* Functions from the `arviz.stats` module are available through ``pymc.<function>`` or ``pymc.stats.<function>``,
47+
* Functions from the ``arviz.stats`` module are available through ``pymc.<function>`` or ``pymc.stats.<function>``,
4848
but for their API documentation please refer to the :ref:`ArviZ documentation <arviz:stats_api>`.
4949

5050
ArviZ is a dependency of PyMC and so, in addition to the locations described above,

docs/source/api/distributions/discrete.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,4 @@ Discrete
2323
.. note::
2424

2525
**OrderedLogistic and OrderedProbit:**
26-
The `OrderedLogistic` and `OrderedProbit` distributions expect the observed values to be 0-based, i.e., they should range from `0` to `K-1`. Using 1-based indexing (like `1, 2, 3,...K`) can result in errors.
26+
The ``OrderedLogistic`` and ``OrderedProbit`` distributions expect the observed values to be 0-based, i.e., they should range from ``0`` to ``K-1``. Using 1-based indexing (like ``1, 2, 3,...K``) can result in errors.

docs/source/api/shape_utils.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ shape_utils
44

55
This submodule contains various functions that apply numpy's broadcasting rules to shape tuples, and also to samples drawn from probability distributions.
66

7-
The main challenge when broadcasting samples drawn from a generative model, is that each random variate has a core shape. When we draw many i.i.d samples from a given RV, for example if we ask for `size_tuple` i.i.d draws, the result usually is a `size_tuple + RV_core_shape`. In the generative model's hierarchy, the downstream RVs that are conditionally dependent on our above sampled values, will get an array with a shape that is inconsistent with the core shape they expect to see for their parameters. This is a problem sometimes because it prevents regular broadcasting in complex hierarchical models, and thus make prior and posterior predictive sampling difficult.
7+
The main challenge when broadcasting samples drawn from a generative model, is that each random variate has a core shape. When we draw many i.i.d samples from a given RV, for example if we ask for ``size_tuple`` i.i.d draws, the result usually is a ``size_tuple + RV_core_shape``. In the generative model's hierarchy, the downstream RVs that are conditionally dependent on our above sampled values, will get an array with a shape that is inconsistent with the core shape they expect to see for their parameters. This is a problem sometimes because it prevents regular broadcasting in complex hierarchical models, and thus make prior and posterior predictive sampling difficult.
88

9-
This module introduces functions that are made aware of the requested `size_tuple` of i.i.d samples, and does the broadcasting on the core shapes, transparently ignoring or moving the i.i.d `size_tuple` prepended axes around.
9+
This module introduces functions that are made aware of the requested ``size_tuple`` of i.i.d samples, and does the broadcasting on the core shapes, transparently ignoring or moving the i.i.d ``size_tuple`` prepended axes around.
1010

1111
.. currentmodule:: pymc.distributions.shape_utils
1212

docs/source/guides/Gaussian_Processes.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ variable models and also some fast approximations. Their usage all follows a
126126
similar pattern: First, a GP is instantiated with a mean function and a
127127
covariance function. Then, GP objects can be added together, allowing for
128128
function characteristics to be carefully modeled and separated. Finally, one
129-
of `prior`, `marginal_likelihood` or `conditional` methods is called on the GP
129+
of ``prior``, ``marginal_likelihood`` or ``conditional`` methods is called on the GP
130130
object to actually construct the PyMC random variable that represents the
131131
function prior.
132132

@@ -148,7 +148,7 @@ conditioned on.
148148
or other, depending on the implementation. See the notebooks for examples.
149149
The :code:`conditional` method works similarly.
150150

151-
Calling the `prior` method will create a PyMC random variable that represents
151+
Calling the ``prior`` method will create a PyMC random variable that represents
152152
the latent function :math:`f(x) = \mathbf{f}`::
153153

154154
f = gp.prior("f", X)
@@ -218,7 +218,7 @@ thesis <https://www.cs.toronto.edu/~duvenaud/thesis.pdf>`_.
218218

219219
The GP objects in PyMC keeps track of these marginals automatically. The
220220
following code sketch shows how to define the conditional distribution of
221-
:math:`f_2^*`. We use `gp.Marginal` in the example, but the same works for
221+
:math:`f_2^*`. We use ``gp.Marginal`` in the example, but the same works for
222222
other implementations. The first block fits the GP prior. We denote
223223
:math:`f_1 + f_2` as just :math:`f` for brevity::
224224

@@ -255,7 +255,7 @@ arguments are required for conditionals of :math:`f1` and :math:`f2`, but not
255255

256256
.. note::
257257
When constructing conditionals, the additional arguments :code:`X`, :code:`y`,
258-
:code:`noise` and :code:`gp` must be provided as a dict called `given`!
258+
:code:`noise` and :code:`gp` must be provided as a dict called ``given``!
259259

260260
Since the marginal likelihoood method of :code:`gp1` or :code:`gp2` weren't called,
261261
their conditionals need to be provided with the required inputs. In the same

docs/source/learn/core_notebooks/Gaussian_Processes.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -123,8 +123,8 @@ variable models and also some fast approximations. Their usage all follows a
123123
similar pattern: First, a GP is instantiated with a mean function and a
124124
covariance function. Then, GP objects can be added together, allowing for
125125
function characteristics to be carefully modeled and separated. Finally, one
126-
of `prior`, `marginal_likelihood` or `conditional` methods is called on the GP
127-
object to actually construct the PyMC random variable that represents the
126+
of ``prior``, ``marginal_likelihood`` or ``conditional`` methods is called on
127+
the GP object to actually construct the PyMC random variable that represents the
128128
function prior.
129129

130130
Using :code:`gp.Latent` for the example, the syntax to first specify the GP
@@ -145,7 +145,7 @@ conditioned on.
145145
or other, depending on the implementation. See the notebooks for examples.
146146
The :code:`conditional` method works similarly.
147147

148-
Calling the `prior` method will create a PyMC random variable that represents
148+
Calling the ``prior`` method will create a PyMC random variable that represents
149149
the latent function :math:`f(x) = \mathbf{f}`::
150150

151151
f = gp.prior("f", X)
@@ -217,7 +217,7 @@ thesis <https://www.cs.toronto.edu/~duvenaud/thesis.pdf>`_.
217217

218218
The GP objects in PyMC keeps track of these marginals automatically. The
219219
following code sketch shows how to define the conditional distribution of
220-
:math:`f_2^*`. We use `gp.Marginal` in the example, but the same works for
220+
:math:`f_2^*`. We use ``gp.Marginal`` in the example, but the same works for
221221
other implementations. The first block fits the GP prior. We denote
222222
:math:`f_1 + f_2` as just :math:`f` for brevity::
223223

@@ -254,7 +254,7 @@ arguments are required for conditionals of :math:`f1` and :math:`f2`, but not
254254

255255
.. note::
256256
When constructing conditionals, the additional arguments :code:`X`, :code:`y`,
257-
:code:`sigma` and :code:`gp` must be provided as a dict called `given`!
257+
:code:`sigma` and :code:`gp` must be provided as a dict called ``given``!
258258

259259
Since the marginal likelihoood method of :code:`gp1` or :code:`gp2` weren't called,
260260
their conditionals need to be provided with the required inputs. In the same

0 commit comments

Comments
 (0)