Skip to content

Commit e4d25f0

Browse files
t-vit-vi
committed
Documentation updates
1 parent 1e0df38 commit e4d25f0

13 files changed

+829
-356
lines changed

‎docs/source/conf.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
2929
# ones.
3030
extensions = ['sphinx.ext.autodoc',
31+
'nbsphinx',
3132
]
3233

3334
# Add any paths that contain templates here, relative to this directory.
@@ -65,3 +66,12 @@ def setup(app):
6566
app.connect('autodoc-skip-member', autodoc_skip_member)
6667

6768
autodoc_inherit_docstrings = False
69+
70+
nbsphinx_requirejs_path = ''
71+
nbsphinx_execute = 'never'
72+
73+
nbsphinx_epilog = """
74+
View this document as a notebook: https://github.com/torchdrift/torchdrift/blob/master/{{ env.doc2path(env.docname, base=None) }}
75+
76+
----
77+
"""

‎docs/source/detectors.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,13 @@ The inputs are expected to be 2d-`Tensor` s: `batch` x `feature_dim`.
99
:imported-members:
1010
:members:
1111
:undoc-members:
12+
13+
Kernels for MMD
14+
---------------
15+
.. autoclass:: torchdrift.detectors.mmd.Kernel
16+
17+
.. autoclass:: torchdrift.detectors.mmd.GaussianKernel
18+
19+
.. autoclass:: torchdrift.detectors.mmd.ExpKernel
20+
21+
.. autoclass:: torchdrift.detectors.mmd.RationalQuadraticKernel

‎docs/source/drift_detection_overview.rst

Lines changed: 0 additions & 189 deletions
This file was deleted.

‎docs/source/drift_detection_overview_model.svg

Lines changed: 0 additions & 121 deletions
This file was deleted.

‎docs/source/index.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,15 @@ TorchDrift is a PyTorch package for monitoring models and detecting drift.
77
:maxdepth: 2
88
:caption: Overview:
99

10-
drift_detection_overview
10+
installation
11+
notebooks/drift_detection_overview
12+
notebooks/note_on_mmd
13+
14+
.. toctree::
15+
:maxdepth: 2
16+
:caption: Examples:
17+
18+
notebooks/drift_detection_on_images
1119

1220
.. toctree::
1321
:maxdepth: 2

‎docs/source/installation.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
Installation
2+
============
3+
4+
To install torchdrift, you may either use the repository
5+
6+
https://github.com/torchdrift/torchdrift/
7+
8+
and `setup.py` from there or use
9+
10+
::
11+
12+
pip install torchdrift
13+
14+
15+
to get the latest release and
16+
17+
::
18+
19+
pip install git+https://github.com/torchdrift/torchdrift/
20+
21+
to install the development version.
22+
23+
Note that `TorchdDrift` is still under rapid development, we expect to break API
24+
compatibility in the versions before 1.0 when we find that usability
25+
benefits from slightly reorganizing things.

‎docs/source/notebooks/drift_detection_on_images.ipynb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../notebooks/drift_detection_on_images.ipynb

‎docs/source/notebooks/drift_detection_overview.ipynb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../notebooks/drift_detection_overview.ipynb

‎docs/source/notebooks/note_on_mmd.ipynb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../notebooks/note_on_mmd.ipynb

0 commit comments

Comments
 (0)