List dims module functionality in the docs

Author: ricardoV94

docs/source/api.rst

@@ -23,6 +23,7 @@ API
  api/backends
  api/misc
  api/testing
+ api/dims
 
 ------------------
 Dimensionality

docs/source/api/dims.rst

@@ -0,0 +1,18 @@
+.. _api_dims:
+
+Dims
+====
+
+This submodule contains functions for defining distributions and operations that use explicit dimensions.
+
+The module is presented in :ref:`dims_module`.
+
+.. currentmodule:: pymc.dims
+
+.. autosummary::
+ :toctree: generated/
+
+ dims/model
+ dims/math
+ dims/distributions
+ dims/transforms

docs/source/api/dims/distributions.rst

@@ -0,0 +1,36 @@
+********************
+Scalar distributions
+********************
+
+.. currentmodule:: pymc.dims
+.. autosummary::
+ :toctree: generated/
+ :template: distribution.rst
+
+ Flat
+ HalfFlat
+ Normal
+ HalfNormal
+ LogNormal
+ StudentT
+ HalfStudentT
+ Cauchy
+ HalfCauchy
+ Beta
+ Laplace
+ Gamma
+ InverseGamma
+
+
+********************
+Vector distributions
+********************
+
+.. currentmodule:: pymc.dims
+.. autosummary::
+ :toctree: generated/
+ :template: distribution.rst
+
+ Categorical
+ MvNormal
+ ZeroSumNormal

docs/source/api/dims/math.rst

@@ -0,0 +1,9 @@
+***************************************
+Mathematical operations with dimensions
+***************************************
+
+This module wraps all the mathematical operations defined in :doc:`pytensor.xtensor.math <pytensor:libdoc_xtensor_math>`.
+
+It includes a ``linalg`` submodule that wraps all the operations defined in :doc:`pytensor.xtensor.linalg <pytensor:libdoc_xtensor_linalg>`.
+
+Operations defined at the module level in :doc:`pytensor.xtensor <pytensor:libdoc_xtensor_module_function>` are available at the parent model in ``pymc.dims`` instead of in here.

docs/source/api/dims/model.rst

@@ -0,0 +1,11 @@
+******************
+Model constructors
+******************
+
+.. currentmodule:: pymc.dims
+.. autosummary::
+ :toctree: generated/
+
+ Data
+ Deterministic
+ Potential

docs/source/api/dims/transforms.rst

@@ -0,0 +1,11 @@
+***********************
+Distribution Transforms
+***********************
+
+.. currentmodule:: pymc.dims.transforms
+.. autosummary::
+ :toctree: generated/
+
+ LogTransform
+ LogOddsTransform
+ ZeroSumTransform

docs/source/learn/core_notebooks/dims_module.ipynb

@@ -5,6 +5,8 @@
  "id": "17e37649edaa8d0d",
  "metadata": {},
  "source": [
+ "(dims_module)=\n",
+ "\n",
  "# PyMC dims module"
  ]
  },

docs/source/learn/core_notebooks/index.md

@@ -5,11 +5,12 @@
 :maxdepth: 1
 
 pymc_overview
-GLM_linear
 model_comparison
 posterior_predictive
 dimensionality
 pymc_pytensor
+dims_module
+GLM_linear
 Gaussian_Processes
 :::