more documentation

braindecode/datautil/signal_target.py

@@ -20,6 +20,7 @@ def apply_to_X_y(fn, *sets):
     Apply a function to all `X` and `y` attributes of all given sets.
     
     Applies function to list of X arrays and to list of y arrays separately.
+    
     Parameters
     ----------
     fn: function

braindecode/datautil/trial_segment.py

@@ -28,8 +28,8 @@ def create_signal_target_from_raw_mne(raw, name_to_start_codes, epoch_ival_ms,
         Epoching interval in milliseconds. In case only `name_to_codes` given,
         represents start offset and stop offset from start markers. In case
         `name_to_stop_codes` given, represents offset from start marker
-         and offset from stop marker. E.g. [500, -500] would mean 500ms
-         after the start marker until 500 ms before the stop marker.
+        and offset from stop marker. E.g. [500, -500] would mean 500ms
+        after the start marker until 500 ms before the stop marker.
     name_to_stop_codes: dict (str -> int or list of int), optional
         Dictionary mapping class names to stop marker code or stop marker codes.
         Order does not matter, dictionary should contain each class in
@@ -71,8 +71,8 @@ def create_signal_target(data, events, fs, name_to_start_codes, epoch_ival_ms,
         Epoching interval in milliseconds. In case only `name_to_codes` given,
         represents start offset and stop offset from start markers. In case
         `name_to_stop_codes` given, represents offset from start marker
-         and offset from stop marker. E.g. [500, -500] would mean 500ms
-         after the start marker until 500 ms before the stop marker.
+        and offset from stop marker. E.g. [500, -500] would mean 500ms
+        after the start marker until 500 ms before the stop marker.
     name_to_stop_codes: dict (str -> int or list of int), optional
         Dictionary mapping class names to stop marker code or stop marker codes.
         Order does not matter, dictionary should contain each class in
@@ -217,7 +217,7 @@ def add_breaks(
         Marker code that will be used for break start markers.
     break_stop_code: int
         Marker code that will be used for break stop markers.
-     name_to_start_codes: OrderedDict (str -> int or list of int)
+    name_to_start_codes: OrderedDict (str -> int or list of int)
         Ordered dictionary mapping class names to start marker code or 
         start marker codes.
     name_to_stop_codes: dict (str -> int or list of int), optional
@@ -229,7 +229,8 @@ def add_breaks(
 
     Returns
     -------
-
+    events: 2d-array
+        Events with break start and stop markers.
     """
     min_samples = (None if min_break_length_ms is None
                    else ms_to_samples(min_break_length_ms, fs))

braindecode/experiments/monitors.py

@@ -174,6 +174,7 @@ def compute_preds_per_trial_for_set(all_preds, input_time_length,
                                         dataset, ):
     """
     Compute predictions per trial from predictions for crops.
+    
     Parameters
     ----------
     all_preds: list of 2darrays (classes x time)
@@ -182,6 +183,7 @@ def compute_preds_per_trial_for_set(all_preds, input_time_length,
         Temporal length of one input to the model.
     dataset: :class:`.SignalAndTarget`
         Dataset the crops were taken from.
+    
     Returns
     -------
     preds_per_trial: list of 2darrays (classes x time)
@@ -201,6 +203,7 @@ def compute_preds_per_trial_from_n_preds_per_trial(
         all_preds, n_preds_per_trial):
     """
     Compute predictions per trial from predictions for crops.
+
     Parameters
     ----------
     all_preds: list of 2darrays (classes x time)

braindecode/mne_ext/signalproc.py

@@ -33,6 +33,7 @@ def concatenate_raws_with_events(raws):
 def resample_cnt(cnt, new_fs):
     """
     Resample continuous recording using `resampy`.
+
     Parameters
     ----------
     cnt: `mne.io.RawArray`

braindecode/torch_ext/modules.py

@@ -1,13 +1,15 @@
 import torch
 
+
 class Expression(torch.nn.Module):
-    """Compute given expression on forward pass.
+    """
+    Compute given expression on forward pass.
     
     Parameters
     ----------
     expression_fn: function
-        Should accept variable number of `torch.autograd.Variable`s to compute
-         its output.
+        Should accept variable number of objects of type
+        `torch.autograd.Variable` to compute its output.
     """
     def __init__(self, expression_fn):
         super(Expression, self).__init__()

docs/conf.py

@@ -33,13 +33,14 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc',
+extensions = [
+    'sphinx.ext.autodoc',
     'sphinx.ext.doctest',
     'sphinx.ext.todo',
     'sphinx.ext.coverage',
     'sphinx.ext.mathjax',
     'sphinx.ext.ifconfig',
-    'sphinx.ext.viewcode',
+    #'sphinx.ext.viewcode',
     'sphinx.ext.githubpages',
     'sphinx.ext.napoleon',
     'nbsphinx',
@@ -73,8 +74,11 @@ def find_source():
     return "https://github.com/robintibor/braindecode/blob/master/%s" % filename
 
 autosummary_generate = True #https://stackoverflow.com/a/21665947/1469195
+autodoc_member_order = 'bysource'
+## Default flags used by autodoc directives
+autodoc_default_flags = ['members', 'show-inheritance']
 
-exclude_patterns = ['_build', 'notebooks/.ipynb_checkpoints', '_templates']
+exclude_patterns = ['_build', '_templates',]
 
 napoleon_google_docstring = False
 napoleon_use_param = False

docs/index.rst

@@ -41,7 +41,7 @@ API
 ===
 
 .. autosummary::
-   :toctree: _autosummary
+   :toctree: source
 
    braindecode.datautil
    braindecode.experiments

setup.py

@@ -15,7 +15,7 @@
     # Versions should comply with PEP440.  For a discussion on single-sourcing
     # the version across setup.py and the project code, see
     # http://packaging.python.org/en/latest/tutorial.html#version
-    version='0.1.4.09',
+    version='0.1.5', # TODO: read form __init__.py?
 
     description='A deep learning toolbox to decode raw time-domain EEG.',
     long_description=long_description,