Merge pull request #29 from RaameshB/dev

(Probably Very Broken) Update to Python 3.9

README.md

@@ -14,12 +14,6 @@ architectures for future work and research.
 
 Join our community to create datasets and deep-learning models! Chat with us on [Gitter](https://gitter.im/EchoTorch/Lobby) and join the [Google Group](https://groups.google.com/forum/#!forum/echotorch/) to collaborate with us.
 
-<center>
-  <a href="https://discord.gg/aTEtQcSJCJ">
-    <img src="docs/images/join_discord.png" alt="Discord" width="120">
-  </a>
-</center>
-
 ## Development status
 
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/echotorch.svg?style=flat-square)

docs/source/conf.py

@@ -0,0 +1,164 @@
+# -*- coding: utf-8 -*-
+#
+# EchoTorch documentation build configuration file, created by
+# sphinx-quickstart on Thu Apr  6 11:30:46 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# 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.
+#
+import os
+import sys
+import echotorch
+#import sphinx_bootstrap_theme
+sys.path.insert(0, os.path.abspath('../../echotorch'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# 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',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.githubpages']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'EchoTorch'
+copyright = '2017, Nils Schaetti'
+author = 'Nils Schaetti'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+#html_theme = 'bootstrap'
+#html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
+
+# 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 = {}
+
+# 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,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'EchoTorchdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# 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 = [
+    (master_doc, 'EchoTorch.tex', 'EchoTorch Documentation',
+     'Nils Schaetti', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'echotorch', 'EchoTorch Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'EchoTorch', 'EchoTorch Documentation',
+     author, 'EchoTorch', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

docs/source/echotorch.datasets.rst

@@ -0,0 +1,38 @@
+echotorch\.datasets package
+===========================
+
+Submodules
+----------
+
+echotorch\.datasets\.MackeyGlassDataset module
+----------------------------------------------
+
+.. automodule:: echotorch.datasets.MackeyGlassDataset
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+echotorch\.datasets\.MemTestDataset module
+------------------------------------------
+
+.. automodule:: echotorch.datasets.MemTestDataset
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+echotorch\.datasets\.NARMADataset module
+----------------------------------------
+
+.. automodule:: echotorch.datasets.NARMADataset
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: echotorch.datasets
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/echotorch.nn.rst

@@ -0,0 +1,32 @@
+echotorch.nn
+============
+
+.. automodule:: torch.nn
+.. currentmodule:: torch.nn
+
+Echo State Layers
+-----------------
+
+ESNCell
+~~~~~~~
+
+.. autoclass:: nn.ESNCell
+    :members:
+
+ESN
+~~~
+
+.. autoclass:: nn.ESN
+    :members:
+
+LiESNCell
+~~~~~~~~~
+
+.. autoclass:: nn.LiESNCell
+    :members:
+
+LiESN
+~~~~~
+
+.. autoclass:: nn.LiESN
+    :members:

docs/source/echotorch.rst

@@ -0,0 +1,19 @@
+echotorch package
+=================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    echotorch.datasets
+    echotorch.nn
+    echotorch.utils
+
+Module contents
+---------------
+
+.. automodule:: echotorch
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/echotorch.utils.rst

@@ -0,0 +1,30 @@
+echotorch\.tools package
+========================
+
+Submodules
+----------
+
+echotorch\.utils\.error_measures module
+---------------------------------
+
+.. automodule:: echotorch.utils.error_measures
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+echotorch\.utils\.utility\_functions module
+-------------------------------------------
+
+.. automodule:: echotorch.utils.utility_functions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: echotorch.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/index.rst

@@ -0,0 +1,32 @@
+.. EchoTorch documentation master file, created by
+   sphinx-quickstart on Thu Apr  6 11:30:46 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+EchoTorch documentation
+=======================
+
+EchoTorch is an pyTorch-based library for Reservoir Computing and Echo State Network using GPUs and CPUs.
+
+.. toctree::
+    :glob:
+    :maxdepth: 1
+    :caption: Notes
+
+    notes/*
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Package Reference
+
+    echotorch
+    echotorch.datasets
+    echotorch.nn
+    echotorch.utils
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/modules.rst

@@ -0,0 +1,7 @@
+echotorch
+=========
+
+.. toctree::
+   :maxdepth: 4
+
+   echotorch

docs/source/notes/esn_learning.rst

@@ -0,0 +1,19 @@
+Echo State Network learning mechanics
+=====================================
+
+This note will present an overview of how Echo State Networks works works
+and its learning mechanics. It's not mandatory to understand the complete
+learning phase, but we recommend understanding the differnce between
+classical ESN learning and gradient descent, it will help you to choose
+which one to use according to cases.
+
+.. _esn_model:
+
+The Echo State Network model
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. _esn_learning:
+
+``esn_learning``
+~~~~~~~~~~~~~~~~
+