Skip to content

[WIP] Reorganize and update documentation #5059

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.

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

Merged
merged 16 commits into from
Nov 24, 2021
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ tags

# Sphinx
_build
docs/jupyter_execute

# Merge tool
*.orig
Expand Down
4 changes: 0 additions & 4 deletions .gitmodules

This file was deleted.

3 changes: 1 addition & 2 deletions conda-envs/environment-dev-py37.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,8 @@ dependencies:
- python-graphviz
- python=3.7
- scipy>1.4.1
- sphinx-autobuild>=0.7
- sphinx-copybutton
- sphinx-notfound-page
- sphinx-panels
- sphinx>=1.5
- typing-extensions
- pip:
Expand Down
3 changes: 1 addition & 2 deletions conda-envs/environment-dev-py38.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,8 @@ dependencies:
- python-graphviz
- python=3.8
- scipy>1.4.1
- sphinx-autobuild>=0.7
- sphinx-copybutton
- sphinx-notfound-page
- sphinx-panels
- sphinx>=1.5
- typing-extensions>=3.7.4
- pip:
Expand Down
3 changes: 1 addition & 2 deletions conda-envs/environment-dev-py39.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,8 @@ dependencies:
- python-graphviz
- python=3.9
- scipy>1.4.1
- sphinx-autobuild>=0.7
- sphinx-copybutton
- sphinx-notfound-page
- sphinx-panels
- sphinx>=1.5
- typing-extensions>=3.7.4
- pip:
Expand Down
2 changes: 1 addition & 1 deletion conda-envs/windows-environment-dev-py38.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ dependencies:
- pytest-cov>=2.5
- pytest>=3.0
- sphinx-autobuild>=0.7
- sphinx-copybutton
- sphinx-notfound-page
- sphinx-panels
- sphinx>=1.5
- watermark
- pip:
Expand Down
Binary file added docs/logos/sponsors/numfocus.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file removed docs/pymc_logo.jpg
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/source/Advanced_usage_of_Aesara_in_PyMC.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:orphan:

(Advanced_usage_of_Aesara_in_PyMC)
..
_referenced in docs/source/notebooks/table_of_contents_tutorials.js

Expand Down
9 changes: 9 additions & 0 deletions docs/source/_templates/footer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<footer class="footer mt-5 mt-md-0">
<div class="container">
{% for footer_item in theme_footer_items %}
<div class="footer-item">
{% include footer_item %}
</div>
{% endfor %}
</div>
</footer>
26 changes: 13 additions & 13 deletions docs/source/_templates/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,25 @@

<!-- Hide left sidebar in home page -->
{% block docs_sidebar %}
{% if pagename != 'index' %}
{{ super() }}
{% endif %}
{% if pagename != 'index' %}
{{ super() }}
{% endif %}
{% endblock %}

<!-- Hide right sidebar in home page -->
{% block docs_toc %}
{% if pagename != 'index' %}
{{ super() }}
{% endif %}
{% if pagename != 'index' %}
{{ super() }}
{% endif %}
{% endblock %}

<!-- Make body have full width in home page -->
{% block docs_main %}
{% if pagename == 'index' %}
<main class="col-12 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
{% block body %} {% endblock %}
</main>
{% else %}
{{ super() }}
{% endif %}
{% if pagename == 'index' %}
<main class="col-12 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
{% block body %} {% endblock %}
</main>
{% else %}
{{ super() }}
{% endif %}
{% endblock %}
13 changes: 8 additions & 5 deletions docs/source/about.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
:orphan:

..
_href from docs/source/index.rst

.. _about:

**********
Expand Down Expand Up @@ -41,10 +36,18 @@ PyMC strives to make Bayesian modeling as simple and painless as possible, allo
* Bayesian models can be embedded in larger programs, and results can be analyzed
with the full power of Python.

What's new in version 4
=======================

:bdg-warning:`TODO`
Add text

What's new in version 3
=======================

:bdg-warning:`TODO`
Move this section to a different place

The third major version of PyMC has benefitted from being re-written from scratch. Substantial improvements in the user interface and performance have resulted from this. While PyMC2 relied on Fortran extensions (via f2py) for most of the computational heavy-lifting, PyMC leverages Aesara, a fork of the Theano library from the Montréal Institute for Learning Algorithms (MILA), for array-based expression evaluation, to perform its computation. What this provides, above all else, is fast automatic differentiation, which is at the heart of the gradient-based sampling and optimization methods currently providing inference for probabilistic programming.

Major changes from previous versions:
Expand Down
21 changes: 5 additions & 16 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
:orphan:

..
_"api" is referenced in html_theme_options docs/source/conf.py

.. _api:

*************
Expand All @@ -13,20 +8,14 @@ API Reference
:maxdepth: 2

api/distributions
api/bounds
api/inference
api/glm
api/gp
api/plots
api/stats
api/backends
api/math
api/data
api/model
api/model_graph
api/variables
api/shape_utils
api/ode
api/samplers
api/smc
api/step_methods
api/inference
api/plots
Copy link
Member

Choose a reason for hiding this comment

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

Now we have a BART module #5058

Copy link
Contributor

@martinacantaro martinacantaro Oct 11, 2021

Choose a reason for hiding this comment

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

Cool, I was going to ask more questions about the api resources, including BART, because we've been talking a bit with @OriolAbril about what needs to be displayed for users, what needs to be displayed for devs and what doesn't need to be displayed at all.
We were basing the current API tree on the Architecture diagram, but that is probably out of date (as evidenced by it not including BART).
What other things should be included/excluded?
For example, does logprob submodule in distributions need to be added?

Copy link
Contributor

Choose a reason for hiding this comment

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

Adding comment by @Sayam753 :

Yes. At least, logp and logcdf functions should be exposed


Indices and tables
===================
Expand Down
24 changes: 0 additions & 24 deletions docs/source/api/backends.rst

This file was deleted.

57 changes: 0 additions & 57 deletions docs/source/api/bounds.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/source/api/data.rst

This file was deleted.

1 change: 1 addition & 0 deletions docs/source/api/distributions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Distributions

distributions/continuous
distributions/discrete
distributions/logprob
distributions/multivariate
distributions/mixture
distributions/simulator
Expand Down
13 changes: 7 additions & 6 deletions docs/source/api/distributions/continuous.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,32 +10,33 @@ Continuous
HalfFlat
Normal
TruncatedNormal
HalfNormal
SkewNormal
Beta
Kumaraswamy
Exponential
Laplace
AsymmetricLaplace
StudentT
HalfStudentT
Cauchy
HalfCauchy
Gamma
InverseGamma
Weibull
HalfStudentT
LogNormal
ChiSquared
HalfNormal
Wald
Pareto
InverseGamma
ExGaussian
VonMises
SkewNormal
Triangular
Gumbel
Rice
Logistic
LogitNormal
Interpolated
Rice
Moyal
AsymmetricLaplace
PolyaGamma

.. automodule:: pymc.distributions.continuous
Expand Down
8 changes: 4 additions & 4 deletions docs/source/api/distributions/discrete.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@ Discrete
.. autosummary::

Binomial
ZeroInflatedBinomial
BetaBinomial
Bernoulli
DiscreteWeibull
Poisson
ZeroInflatedPoisson
NegativeBinomial
Constant
ZeroInflatedPoisson
ZeroInflatedBinomial
ZeroInflatedNegativeBinomial
DiscreteUniform
Geometric
HyperGeometric
Categorical
DiscreteWeibull
Constant
OrderedLogistic
OrderedProbit

Expand Down
15 changes: 8 additions & 7 deletions docs/source/api/distributions/multivariate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,17 @@ Multivariate
.. autosummary::

MvNormal
MatrixNormal
KroneckerNormal
MvStudentT
Wishart
LKJCholeskyCov
LKJCorr
Multinomial
OrderedMultinomial
Dirichlet
Multinomial
DirichletMultinomial
OrderedMultinomial
Wishart
WishartBartlett
LKJCorr
LKJCholeskyCov
MatrixNormal
KroneckerNormal
CAR

.. automodule:: pymc.distributions.multivariate
Expand Down
2 changes: 2 additions & 0 deletions docs/source/api/distributions/simulator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ Simulator
.. currentmodule:: pymc.distributions.simulator
.. autosummary::

SimulatorRV
Simulator
KullbackLiebler

.. automodule:: pymc.distributions.simulator
:members:
Loading