Skip to content

WIP: Enhancing inference docs #1969

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

Closed
wants to merge 1 commit into from
Closed

WIP: Enhancing inference docs #1969

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
39 changes: 39 additions & 0 deletions docs/source/api/inference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,13 @@ ADVI

.. currentmodule:: pymc3.variational.advi

.. autosummary::

TestFunction
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They aren't in pymc3.variational.advi, but in pymc3.variational.inference, so this doesn't work.

ADVI
FullRankADVI
Inference

.. automodule:: pymc3.variational.advi
:members:

Expand All @@ -65,3 +72,35 @@ ADVI minibatch

.. automodule:: pymc3.variational.advi_minibatch
:members:

Inference
^^^^^^^^^

.. currentmodule:: pymc3.variational.operators

.. automodule:: pymc3.variational.operators
:members:

OPVI
^^^^

.. currentmodule:: pymc3.variational.opvi

.. automodule:: pymc3.variational.opvi
:members:

SVGD
^^^^
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

None of the methods here have a docstring, so nothing shows up in the doc.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think @ferrine has re-implemented these in OPVI, so we can probably drop SVGD for now.


.. currentmodule:: pymc3.variational.svgd

.. automodule:: pymc3.variational.svgd
:members:

Updates
^^^^^^^

.. currentmodule:: pymc3.variational.updates

.. automodule:: pymc3.variational.updates
:members: