Skip to content

Commit e4ebfb9

Browse files
committed
Fix documentation
1 parent 0aaa4ee commit e4ebfb9

File tree

7 files changed

+6
-29
lines changed

7 files changed

+6
-29
lines changed

docs/source/conf.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727
# The full version, including alpha/beta/rc tags
2828
release = "not set"
2929

30-
3130
# -- General configuration ---------------------------------------------------
3231

3332
# If your documentation needs a minimal Sphinx version, state it here.
@@ -59,7 +58,7 @@
5958
#
6059
# This is also used if you do content translation via gettext catalogs.
6160
# Usually you set "language" from the command line for these cases.
62-
language = None
61+
language = "en"
6362

6463
# List of patterns, relative to source directory, that match files and
6564
# directories to ignore when looking for source files.

docs/source/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ API reference
2323

2424
modules/innvestigate
2525
modules/analyzer
26-
modules/applications
2726
modules/tools
2827
modules/utils
2928

docs/source/modules/analyzer.rst

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,6 @@ Layer-wise relevance propagation
2424
:undoc-members:
2525

2626

27-
Pattern methods
28-
---------------
29-
30-
.. automodule:: innvestigate.analyzer.pattern_based
31-
:members:
32-
:undoc-members:
33-
3427
Deep Taylor
3528
---------------
3629

docs/source/modules/applications.rst

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

docs/source/modules/tools.rst

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
11
innvestigate.tools
22
==================
33

4-
Pattern Computation
5-
---------------
6-
7-
.. automodule:: innvestigate.tools.pattern
8-
:members: PatternComputer
9-
:undoc-members: BasePattern
10-
114
Perturbation Analysis
125
---------------
136

docs/source/modules/utils.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@ Visualizations
1515
Keras-Utils
1616
------------
1717

18-
.. automodule:: innvestigate.utils.keras.graph
19-
:members: copy_layer, copy_layer_wo_act, model_wo_softmax, get_model_execution_graph, reverse_model
18+
.. automodule:: innvestigate.backend.graph
19+
:members: copy_layer, copy_layer_wo_activation, model_wo_softmax, get_model_execution_graph, reverse_model
2020
:undoc-members:

src/innvestigate/backend/graph.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1000,6 +1000,7 @@ def reverse_model(
10001000
"""
10011001
Reverses a Keras model based on the given reverse functions.
10021002
Returns two values:
1003+
10031004
1. the reverted tensors for the according model inputs.
10041005
2. If `return_all_reversed_tensors` is true, a dictionary of all reversed tensors,
10051006
otherwise None.
@@ -1008,10 +1009,12 @@ def reverse_model(
10081009
:param reverse_mappings: Either a callable that matches layers to
10091010
mappings or a dictionary with layers as keys and mappings as values.
10101011
Allowed as mapping forms are:
1012+
10111013
* A function of form (A) f(Xs, Ys, reversed_Ys, reverse_state).
10121014
* A function of form f(B) f(layer, reverse_state) that returns
10131015
a function of form (A).
10141016
* A :class:`ReverseMappingBase` subclass.
1017+
10151018
:param default_reverse_mapping: A function that reverses layers for
10161019
which no mapping was given by param "reverse_mappings".
10171020
:param head_mapping: Map output tensors to new values before passing

0 commit comments

Comments
 (0)