Skip to content

Commit

Permalink
Merge pull request #201 from jrzaurin/fix_docs
Browse files Browse the repository at this point in the history
brought docs folder back
  • Loading branch information
jrzaurin authored Feb 17, 2024
2 parents 452b143 + fa07e12 commit b1bf2fa
Show file tree
Hide file tree
Showing 38 changed files with 1,423 additions and 224 deletions.
21 changes: 21 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXPROJ = pytorch_widedeep
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
45 changes: 45 additions & 0 deletions docs/_static/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
body a {
font-weight: bold;
}

.math {
text-align: left;
}

.eqno {
float: right;
}

div.ethical-rtd {
/* hide ads */
display: none;
}

.rst-content dl:not(.docutils) dl dt strong {
padding-left: 6pt;
}

.rst-content dl:not(.docutils) dl dt span {
color: #777;
}

.rst-content dl:not(.docutils) dl dt span.classifier-delimiter {
padding-left: 6pt;
padding-right: 6pt;
}

.rst-content dl:not(.docutils) dl dt span.classifier {
padding-right: 6pt;
}

.rst-content dl:not(.docutils) dl dt a.reference.internal span.xref.std.std-term {
color: #2980B9;
}

.wy-nav-content {
max-width: none; !important;
}

div.container a.header-logo {
background-image: url("../figures/widedeep_logo.png");
}
Binary file added docs/_static/img/widedeep_logo_docs.ico
Binary file not shown.
15 changes: 15 additions & 0 deletions docs/bayesian_models.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
The ``bayesian models`` module
==============================

This module contains the two Bayesian Models available in this library, namely
the bayesian version of the ``Wide`` and ``TabMlp`` models, referred as
``BayesianWide`` and ``BayesianTabMlp``


.. autoclass:: pytorch_widedeep.bayesian_models.tabular.bayesian_linear.bayesian_wide.BayesianWide
:exclude-members: forward
:members:

.. autoclass:: pytorch_widedeep.bayesian_models.tabular.bayesian_mlp.bayesian_tab_mlp.BayesianTabMlp
:exclude-members: forward
:members:
29 changes: 29 additions & 0 deletions docs/callbacks.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
Callbacks
=========

Here are the 5 callbacks available in ``pytorch-widedepp``: ``History``,
``LRHistory``, ``ModelCheckpoint``, ``EarlyStopping`` and ``RayTuneReporter``.

.. note:: ``History`` runs by default, so it should not be passed
to the ``Trainer``

.. autoclass:: pytorch_widedeep.callbacks.History
:members:

.. autoclass:: pytorch_widedeep.callbacks.LRShedulerCallback
:members:

.. autoclass:: pytorch_widedeep.callbacks.MetricCallback
:members:

.. autoclass:: pytorch_widedeep.callbacks.LRHistory
:members:

.. autoclass:: pytorch_widedeep.callbacks.ModelCheckpoint
:members:

.. autoclass:: pytorch_widedeep.callbacks.EarlyStopping
:members:

.. autoclass:: pytorch_widedeep.callbacks.RayTuneReporter
:members:
Loading

0 comments on commit b1bf2fa

Please sign in to comment.