Add source files for sphinx

doc/source/conf.py

@@ -0,0 +1,163 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/stable/config
+
+# -- Path setup --------------------------------------------------------------
+
+# 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
+sys.path.insert(0, os.path.abspath('../../'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'DeepVO'
+copyright = '2018, Rasmus Diederichsen, Alexander Mock, Christian Heiden'
+author = 'Rasmus Diederichsen, Alexander Mock, Christian Heiden'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = ''
+
+
+# -- 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.viewcode',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.napoleon',
+    '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'
+
+# 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 pattern also affects html_static_path and html_extra_path .
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# -- 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 = 'alabaster'
+
+# 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'DeepVOdoc'
+
+
+# -- 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, 'DeepVO.tex', 'DeepVO Documentation',
+     'Rasmus Diederichsen, Alexander Mock, Christian Heiden', '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, 'deepvo', 'DeepVO 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, 'DeepVO', 'DeepVO Documentation',
+     author, 'DeepVO', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Extension configuration -------------------------------------------------

doc/source/flownet.rst

@@ -0,0 +1,7 @@
+flownet module
+==============
+
+.. automodule:: flownet
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/index.rst

@@ -0,0 +1,22 @@
+.. DeepVO documentation master file, created by
+   sphinx-quickstart on Mon Mar  5 21:18:20 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to DeepVO's documentation!
+==================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   modules
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

doc/source/main.rst

@@ -0,0 +1,7 @@
+main module
+===========
+
+.. automodule:: main
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/model.rst

@@ -0,0 +1,7 @@
+model module
+============
+
+.. automodule:: model
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/modules.rst

@@ -0,0 +1,13 @@
+final_project
+=============
+
+.. toctree::
+   :maxdepth: 4
+
+   flownet
+   main
+   model
+   performance_visualizer
+   preprocess_data
+   sequence_visualizer
+   utils

doc/source/performance_visualizer.rst

@@ -0,0 +1,7 @@
+performance\_visualizer module
+==============================
+
+.. automodule:: performance_visualizer
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/preprocess_data.rst

@@ -0,0 +1,7 @@
+preprocess\_data module
+=======================
+
+.. automodule:: preprocess_data
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/sequence_visualizer.rst

@@ -0,0 +1,7 @@
+sequence\_visualizer module
+===========================
+
+.. automodule:: sequence_visualizer
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/utils.rst

@@ -0,0 +1,7 @@
+utils module
+============
+
+.. automodule:: utils
+    :members:
+    :undoc-members:
+    :show-inheritance:

flownet.py

@@ -1,9 +1,9 @@
 '''
 .. module:: flownet
 
-    Contains utilities for incorporating FlowNetSimple weights. The weights can be downloaded from
-    `here <https://s3.us-east-2.amazonaws.com/flownetdata/weights.tar.gz>`_ . This file contains all
-    weights for all FlowNet versions and is thus unfortunately huge.
+Contains utilities for incorporating FlowNetSimple weights. The weights can be downloaded from
+`here <https://s3.us-east-2.amazonaws.com/flownetdata/weights.tar.gz>`_ . This file contains all
+weights for all FlowNet versions and is thus unfortunately huge.
 
 .. data:: flownet_prefix
     The variable scope in which the flownet weights live

main.py

@@ -1,7 +1,8 @@
 #!/usr/bin/env python3.6
 '''
 .. module:: main
-    Module for starting the training, testing and plotting functions
+
+Module for starting the training, testing and plotting functions
 
 .. moduleauthor:: Rasmus Diederichsen
 '''

preprocess_data.py

@@ -1,4 +1,10 @@
 #!/usr/bin/env python
+'''
+.. module:: preprocess_data
+    Contains functions for normalizing and converting the raw data.
+
+.. moduleauthor:: Rasmus Diederichsen
+'''
 
 from argparse import ArgumentParser
 import numpy as np
@@ -89,18 +95,22 @@ def mean_normalize(data_manager):
         data_manager.saveImage(idx, (img - mean_accumlator))
     print('\nDone')
 
+
 def add_pi_to_poses(data_manager):
+    '''Add Pi to every pose angle.'''
     N = len(data_manager)
     for idx in range(N):
         pose = data_manager.loadPose(idx)
-        pose[...,3:6] = pose[...,3:6] + np.pi
+        pose[..., 3:6] = pose[..., 3:6] + np.pi
         data_manager.savePose(idx, pose)
 
+
 def sub_pi_from_poses(data_manager):
+    '''Subtract Pi from every pose angle.'''
     N = len(data_manager)
     for idx in range(N):
         pose = data_manager.loadPose(idx)
-        pose[...,3:6] = pose[...,3:6] - np.pi
+        pose[..., 3:6] = pose[..., 3:6] - np.pi
         data_manager.savePose(idx, pose)
 
 

sequence_visualizer.py

@@ -1,9 +1,15 @@
+'''
+.. module:: sequence_visualizer
+    Contains the :py:class:`SequenceVisualizer` to visualise training success.
+
+.. moduleauthor:: Christian Heiden
+'''
 import numpy as np
 import matplotlib.pyplot as plt
 
 class SequenceVisualizer(object):
 
-    """This class visualizes the output of the network"""
+    '''This class visualizes the output of the network'''
 
     def __init__(self):
         super(SequenceVisualizer, self).__init__()
@@ -71,5 +77,5 @@ def main():
     vis.plot_path()
 
 
-if __name__ == "__main__":
+if __name__ == '__main__':
     main()