Skip to content

Commit b473b9d

Browse files
author
mercury0100
committed
fix links that should be references
1 parent 8d3c2d4 commit b473b9d

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/source/learn/core_notebooks/dims_module.ipynb

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@
3434
":::\n",
3535
"\n",
3636
"**Related API reference:** \n",
37-
"- [Dims — distributions](https://www.pymc.io/projects/docs/en/stable/api/dims/distributions.html) \n",
38-
"- [Dims — transforms](https://www.pymc.io/projects/docs/en/stable/api/dims/transforms.html) \n",
39-
"- [Dims — math](https://www.pymc.io/projects/docs/en/stable/api/dims/math.html)\n",
37+
"- {doc}`Dims — distributions </api/dims/distributions>`\n",
38+
"- {doc}`Dims — transforms </api/dims/transforms>`\n",
39+
"- {doc}`Dims — math </api/dims/math>`\n",
4040
"\n",
4141
"## A simple example\n",
4242
"\n",
@@ -315,13 +315,13 @@
315315
"\n",
316316
"There are some notable differences:\n",
317317
"\n",
318-
"1. [`ZeroSumNormal`](https://www.pymc.io/projects/docs/en/stable/api/dims/distributions.html#pymc.distributions.ZeroSumNormal) takes a `core_dims` argument instead of `n_zerosum_axes`. This tells PyMC which of the `dims` that define the distribution are constrained to be zero-summed. All distributions that take non-scalar parameters now require a `core_dims` argument. Previously, they were assumed to be right-aligned by the user (see {doc}`dimensionality`). Now you don't have to worry about the order of dimensions in your model, only their meaning.\n",
318+
"1. {class}`~pymc.distributions.ZeroSumNormal` takes a `core_dims` argument instead of `n_zerosum_axes`. This tells PyMC which of the `dims` that define the distribution are constrained to be zero-summed. All distributions that take non-scalar parameters now require a `core_dims` argument. Previously, they were assumed to be right-aligned by the user (see {doc}`dimensionality`). Now you don't have to worry about the order of dimensions in your model, only their meaning.\n",
319319
"\n",
320320
"2. The `trial_preference` computation aligns dimensions for broadcasting automatically. Note we use {func}`pymc.dims.Deterministic` (not {func}`pymc.Deterministic`), which automatically propagates the `dims` to the model object.\n",
321321
"\n",
322322
"3. The `softmax` operation specifies the `dim` argument, not the positional axis. *Note:* The parameter is called `dim` and not `core_dims` because we try to stay as close as possible to the Xarray API (which uses `dim` throughout). We make an exception for distributions because they already have the `dims` argument.\n",
323323
"\n",
324-
"4. [`Categorical`](https://www.pymc.io/projects/docs/en/stable/api/dims/distributions.html#pymc.distributions.Categorical) observed variables, like `ZeroSumNormal`, require a `core_dims` argument to specify which dimension corresponds to the probability vector. Previously, it was necessary to place this dimension explicitly on the rightmost axis — not anymore!\n",
324+
"4. {class}`~pymc.distributions.Categorical` observed variables, like `ZeroSumNormal`, require a `core_dims` argument to specify which dimension corresponds to the probability vector. Previously, it was necessary to place this dimension explicitly on the rightmost axis — not anymore!\n",
325325
"\n",
326326
"5. Even when `dims` are not specified for either `trial_preference` or `response`, PyMC automatically infers them.\n",
327327
"\n",
@@ -891,7 +891,7 @@
891891
"\n",
892892
" * All vector arguments (and observed values) must have known dims. An error is raised otherwise.\n",
893893
"\n",
894-
" * Distributions with non-scalar inputs will require a `core_dims` argument. The meaning of the `core_dims` argument will be denoted in the docstrings of each distribution. For example, for the [`MvNormal`](https://www.pymc.io/projects/docs/en/stable/api/dims/generated/pymc.dims.MvNormal.html#pymc.dims.MvNormal), the `core_dims` are the two dimensions of the covariance matrix, one (and only one) of which must also be present in the mean parameter. The shared `core_dim` is the one that persists in the output. Sometimes the order of `core_dims` will be important!\n",
894+
" * Distributions with non-scalar inputs will require a `core_dims` argument. The meaning of the `core_dims` argument will be denoted in the docstrings of each distribution. For example, for the {class}`~pymc.distributions.MvNormal`, the `core_dims` are the two dimensions of the covariance matrix, one (and only one) of which must also be present in the mean parameter. The shared `core_dim` is the one that persists in the output. Sometimes the order of `core_dims` will be important!\n",
895895
"\n",
896896
" * `dims` accept ellipsis, and variables are transposed to match the user-specified `dims` argument.\n",
897897
"\n",

0 commit comments

Comments
 (0)