Merge pull request #49 from phausamann/develop

PEP8 compliance

Author: phausamann

doc/conf.py

@@ -15,12 +15,17 @@
 import sys
 import os
 
+# pngmath / imgmath compatibility layer for different sphinx versions
+import sphinx
+import sklearn_xarray
+from distutils.version import LooseVersion
+
 import sphinx_rtd_theme
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+# sys.path.insert(0, os.path.abspath('.'))
 
 # -- General configuration ---------------------------------------------------
 
@@ -32,7 +37,7 @@
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'
 
 sys.path.append(os.path.join(os.path.dirname(__name__), '..'))
 
@@ -51,20 +56,16 @@
     'sphinx.ext.autosummary'
 ]
 
-# pngmath / imgmath compatibility layer for different sphinx versions
-import sphinx
-import sklearn_xarray
-from distutils.version import LooseVersion
 if LooseVersion(sphinx.__version__) < LooseVersion('1.4'):
     extensions.append('sphinx.ext.pngmath')
 else:
     extensions.append('sphinx.ext.imgmath')
 
 sphinx_gallery_conf = {
     # path to your examples scripts
-    'examples_dirs' : '../examples',
+    'examples_dirs': '../examples',
     # path where to save gallery generated examples
-    'gallery_dirs'  : 'auto_examples'}
+    'gallery_dirs': 'auto_examples'}
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -73,7 +74,7 @@
 source_suffix = '.rst'
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
 
 # Generate the plots for the gallery
 plot_gallery = True
@@ -96,41 +97,41 @@
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
+# language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns = ['_build']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
-#default_role = None
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
 add_module_names = False
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 # If true, keep warnings as "system message" paragraphs in the built documents.
-#keep_warnings = False
+# keep_warnings = False
 
 
 # -- Options for HTML output ----------------------------------------------
@@ -142,26 +143,26 @@
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+# html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+# html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+# html_logo = None
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# html_favicon = None
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -171,93 +172,92 @@
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
 # directly to the root of the documentation.
-#html_extra_path = []
+# html_extra_path = []
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_domain_indices = True
+# html_domain_indices = True
 
 # If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'sklearn-xarraydoc'
 
-
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
+    # The paper size ('letterpaper' or 'a4paper').
+    # 'papersize': 'letterpaper',
 
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
+    # The font size ('10pt', '11pt' or '12pt').
+    # 'pointsize': '10pt',
 
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
+    # Additional stuff for the LaTeX preamble.
+    # 'preamble': '',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  ('index', 'sklearn-xarray.tex', u'sklearn-xarray Documentation',
-   u'Peter Hausamann', 'manual'),
+    ('index', 'sklearn-xarray.tex', u'sklearn-xarray Documentation',
+     u'Peter Hausamann', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
 
 # -- Options for manual page output ---------------------------------------
@@ -270,7 +270,7 @@
 ]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -279,11 +279,12 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'sklearn-xarray', u'sklearn-xarray Documentation',
-   u'Peter Hausamann', 'sklearn-xarray', 'Integrate xarray and sklearn.',
-   'Miscellaneous'),
+    ('index', 'sklearn-xarray', u'sklearn-xarray Documentation',
+     u'Peter Hausamann', 'sklearn-xarray', 'Integrate xarray and sklearn.',
+     'Miscellaneous'),
 ]
 
+
 def generate_example_rst(app, what, name, obj, options, lines):
     # generate empty examples files, so that we don't get
     # inclusion errors if there are no examples for a class / module
@@ -297,17 +298,18 @@ def generate_example_rst(app, what, name, obj, options, lines):
 def setup(app):
     app.connect('autodoc-process-docstring', generate_example_rst)
 
+
 # Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
+# texinfo_appendices = []
 
 # If false, no module index is generated.
-#texinfo_domain_indices = True
+# texinfo_domain_indices = True
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+# texinfo_show_urls = 'footnote'
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False
+# texinfo_no_detailmenu = False
 
 
 # Example configuration for intersphinx: refer to the Python standard library.

examples/plot_activity_recognition.py

@@ -13,11 +13,11 @@
 
 The example performs activity recognition from raw accelerometer data with a
 Gaussian naive Bayes classifier. It uses the
-`WISDM activity prediction dataset`_ which contains the activities
+`WISDM`_ activity prediction dataset which contains the activities
 walking, jogging, walking upstairs, walking downstairs, sitting and standing
 from 36 different subjects.
 
-.. _WISDM activity prediction dataset: http://www.cis.fordham.edu/wisdm/dataset.php
+.. _WISDM: http://www.cis.fordham.edu/wisdm/dataset.php
 """
 
 from __future__ import print_function
@@ -72,7 +72,7 @@
 # The preprocessing consists of splitting the data into segments, removing
 # segments with `nan` values and standardizing. Since the accelerometer data is
 # three-dimensional but the standardizer and classifier expect a one-dimensional
-# feature vector, we have to vectorize the samples.
+#  feature vector, we have to vectorize the samples.
 #
 # Finally, we use PCA and a naive Bayes classifier for classification.
 

requirements.txt

@@ -4,3 +4,4 @@ pandas>=0.20
 cython>=0.25
 numpy>=1.12
 scipy>=1.0
+six

sklearn_xarray/common/wrappers.py

@@ -121,8 +121,8 @@ def __init__(self, estimator=None, reshapes=None, sample_dim=None,
         for p in params:
             setattr(self, p, params[p])
 
-        self._param_names = self._get_param_names() + \
-                            self.estimator._get_param_names()
+        self._param_names = \
+            self._get_param_names() + self.estimator._get_param_names()
 
         self._decorate()
 
@@ -361,8 +361,8 @@ def set_params(self, **params):
 
 
 class TransformerWrapper(
-    EstimatorWrapper, _ImplementsTransformMixin,
-    _ImplementsFitTransformMixin, _ImplementsInverseTransformMixin):
+        EstimatorWrapper, _ImplementsTransformMixin,
+        _ImplementsFitTransformMixin, _ImplementsInverseTransformMixin):
     """ A wrapper around sklearn transformers compatible with xarray objects.
 
     Parameters
@@ -376,7 +376,7 @@ class TransformerWrapper(
 
 
 class RegressorWrapper(
-    EstimatorWrapper, _ImplementsPredictMixin, _ImplementsScoreMixin):
+        EstimatorWrapper, _ImplementsPredictMixin, _ImplementsScoreMixin):
     """ A wrapper around sklearn regressors compatible with xarray objects.
 
     Parameters
@@ -391,7 +391,7 @@ class RegressorWrapper(
 
 
 class ClassifierWrapper(
-    EstimatorWrapper, _ImplementsPredictMixin, _ImplementsScoreMixin):
+        EstimatorWrapper, _ImplementsPredictMixin, _ImplementsScoreMixin):
     """ A wrapper around sklearn classifiers compatible with xarray objects.
 
     Parameters

sklearn_xarray/datasets.py

@@ -19,7 +19,7 @@ def load_dummy_dataset():
     """ Load a Dataset for demonstration purposes. """
 
     return xr.Dataset(
-        {'var_1' : (['sample', 'feature'], np.random.random((100, 10)))},
+        {'var_1': (['sample', 'feature'], np.random.random((100, 10)))},
         coords={'sample': range(100), 'feature': range(10)}
     )
 

sklearn_xarray/externals/__init__.py

@@ -3,4 +3,4 @@
 try:
     import numpy_groupies
 except ImportError:
-    from . import _numpy_groupies_np as numpy_groupies
+    from . import _numpy_groupies_np as numpy_groupies