From 678cf9c21016d535a3a8d32f6bbfe6bbf5855797 Mon Sep 17 00:00:00 2001 From: Joeper Serrano Date: Sun, 20 Oct 2019 02:50:55 +0900 Subject: [PATCH] Remove Outdated LMnet Docs (#541) --- lmnet/docs/source/Makefile | 241 ------------ lmnet/docs/source/_templates/module.rst | 70 ---- lmnet/docs/source/_templates/package.rst | 89 ----- lmnet/docs/source/blocks.rst | 29 -- lmnet/docs/source/conf.py | 368 ------------------ lmnet/docs/source/data_augmentor.rst | 46 --- lmnet/docs/source/data_processor.rst | 35 -- lmnet/docs/source/environment.rst | 28 -- lmnet/docs/source/index.rst | 28 -- lmnet/docs/source/layers.layers.rst | 34 -- lmnet/docs/source/layers.quantization.rst | 32 -- lmnet/docs/source/layers.rst | 20 - lmnet/docs/source/make.bat | 284 -------------- lmnet/docs/source/modules.rst | 14 - lmnet/docs/source/networks.base.rst | 27 -- .../source/networks.classification.base.rst | 27 -- .../source/networks.classification.lmnet.rst | 27 -- ...networks.classification.lmnet_quantize.rst | 27 -- .../source/networks.classification.resnet.rst | 27 -- lmnet/docs/source/networks.classification.rst | 23 -- .../source/networks.classification.vgg16.rst | 27 -- lmnet/docs/source/networks.lmnet_multi.rst | 34 -- lmnet/docs/source/networks.rst | 26 -- lmnet/docs/source/pre_processor.rst | 45 --- lmnet/docs/source/quantizations.binary.rst | 28 -- lmnet/docs/source/quantizations.linear.rst | 27 -- lmnet/docs/source/quantizations.rst | 22 -- lmnet/docs/source/quantizations.ternary.rst | 28 -- 28 files changed, 1713 deletions(-) delete mode 100644 lmnet/docs/source/Makefile delete mode 100644 lmnet/docs/source/_templates/module.rst delete mode 100644 lmnet/docs/source/_templates/package.rst delete mode 100644 lmnet/docs/source/blocks.rst delete mode 100644 lmnet/docs/source/conf.py delete mode 100644 lmnet/docs/source/data_augmentor.rst delete mode 100644 lmnet/docs/source/data_processor.rst delete mode 100644 lmnet/docs/source/environment.rst delete mode 100644 lmnet/docs/source/index.rst delete mode 100644 lmnet/docs/source/layers.layers.rst delete mode 100644 lmnet/docs/source/layers.quantization.rst delete mode 100644 lmnet/docs/source/layers.rst delete mode 100644 lmnet/docs/source/make.bat delete mode 100644 lmnet/docs/source/modules.rst delete mode 100644 lmnet/docs/source/networks.base.rst delete mode 100644 lmnet/docs/source/networks.classification.base.rst delete mode 100644 lmnet/docs/source/networks.classification.lmnet.rst delete mode 100644 lmnet/docs/source/networks.classification.lmnet_quantize.rst delete mode 100644 lmnet/docs/source/networks.classification.resnet.rst delete mode 100644 lmnet/docs/source/networks.classification.rst delete mode 100644 lmnet/docs/source/networks.classification.vgg16.rst delete mode 100644 lmnet/docs/source/networks.lmnet_multi.rst delete mode 100644 lmnet/docs/source/networks.rst delete mode 100644 lmnet/docs/source/pre_processor.rst delete mode 100644 lmnet/docs/source/quantizations.binary.rst delete mode 100644 lmnet/docs/source/quantizations.linear.rst delete mode 100644 lmnet/docs/source/quantizations.rst delete mode 100644 lmnet/docs/source/quantizations.ternary.rst diff --git a/lmnet/docs/source/Makefile b/lmnet/docs/source/Makefile deleted file mode 100644 index 270e67862..000000000 --- a/lmnet/docs/source/Makefile +++ /dev/null @@ -1,241 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build -PAPER ?= -BUILDDIR = ../_build - -# Internal variables. -PAPEROPT_a4 = -D latex_elements.papersize=a4 -PAPEROPT_letter = -D latex_elements.papersize=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . - -.PHONY: help -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and an HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " applehelp to make an Apple Help Book" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " epub3 to make an epub3" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" - @echo " lualatexpdf to make LaTeX files and run them through lualatex" - @echo " xelatexpdf to make LaTeX files and run them through xelatex" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " xml to make Docutils-native XML files" - @echo " pseudoxml to make pseudoxml-XML files for display purposes" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - @echo " coverage to run coverage check of the documentation (if enabled)" - @echo " dummy to check syntax errors of document sources" - -.PHONY: clean -clean: - rm -rf $(BUILDDIR)/* - -.PHONY: html -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -.PHONY: dirhtml -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -.PHONY: singlehtml -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -.PHONY: pickle -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -.PHONY: json -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -.PHONY: htmlhelp -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -.PHONY: qthelp -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/lmnet.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/lmnet.qhc" - -.PHONY: applehelp -applehelp: - $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp - @echo - @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." - @echo "N.B. You won't be able to view it unless you put it in" \ - "~/Library/Documentation/Help or install it in your application" \ - "bundle." - -.PHONY: devhelp -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/lmnet" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/lmnet" - @echo "# devhelp" - -.PHONY: epub -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -.PHONY: epub3 -epub3: - $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3 - @echo - @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." - -.PHONY: latex -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -.PHONY: latexpdf -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: latexpdfja -latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through platex and dvipdfmx..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: lualatexpdf -lualatexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through lualatex..." - $(MAKE) PDFLATEX=lualatex -C $(BUILDDIR)/latex all-pdf - @echo "lualatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: xelatexpdf -xelatexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through xelatex..." - $(MAKE) PDFLATEX=xelatex -C $(BUILDDIR)/latex all-pdf - @echo "xelatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: text -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -.PHONY: man -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -.PHONY: texinfo -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -.PHONY: info -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -.PHONY: gettext -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -.PHONY: changes -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -.PHONY: linkcheck -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -.PHONY: doctest -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." - -.PHONY: coverage -coverage: - $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage - @echo "Testing of coverage in the sources finished, look at the " \ - "results in $(BUILDDIR)/coverage/python.txt." - -.PHONY: xml -xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml - @echo - @echo "Build finished. The XML files are in $(BUILDDIR)/xml." - -.PHONY: pseudoxml -pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml - @echo - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." - -.PHONY: dummy -dummy: - $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy - @echo - @echo "Build finished. Dummy builder generates no files." diff --git a/lmnet/docs/source/_templates/module.rst b/lmnet/docs/source/_templates/module.rst deleted file mode 100644 index 71ad8dc08..000000000 --- a/lmnet/docs/source/_templates/module.rst +++ /dev/null @@ -1,70 +0,0 @@ -{{ fullname }} module -{% for item in range(7 + fullname|length) -%}={%- endfor %} - -.. currentmodule:: {{ fullname }} - -.. automodule:: {{ fullname }} - {% if members -%} - :members: {{ members|join(", ") }} - :undoc-members: - :show-inheritance: - :member-order: bysource - - Summary - ------- - - {%- if exceptions %} - - Exceptions: - - .. autosummary:: - :nosignatures: -{% for item in exceptions %} - {{ item }} -{%- endfor %} - {%- endif %} - - {%- if classes %} - - Classes: - - .. autosummary:: - :nosignatures: -{% for item in classes %} - {{ item }} -{%- endfor %} - {%- endif %} - - {%- if functions %} - - Functions: - - .. autosummary:: - :nosignatures: -{% for item in functions %} - {{ item }} -{%- endfor %} - {%- endif %} -{%- endif %} - - {%- if data %} - - Data: - - .. autosummary:: - :nosignatures: -{% for item in data %} - {{ item }} -{%- endfor %} - {%- endif %} - -{% if all_refs %} - ``__all__``: {{ all_refs|join(", ") }} -{%- endif %} - - -{% if members %} - Reference - --------- - -{%- endif %} diff --git a/lmnet/docs/source/_templates/package.rst b/lmnet/docs/source/_templates/package.rst deleted file mode 100644 index 5d0b90399..000000000 --- a/lmnet/docs/source/_templates/package.rst +++ /dev/null @@ -1,89 +0,0 @@ -{{ fullname }} package -{% for item in range(8 + fullname|length) -%}={%- endfor %} - -.. automodule:: {{ fullname }} - {% if members -%} - :members: {{ members|join(", ") }} - :undoc-members: - :show-inheritance: - {%- endif %} - -{% if submodules %} - Submodules: - - .. toctree:: - :maxdepth: 1 -{% for item in submodules %} - {{ fullname }}.{{ item }} - {%- endfor %} - {%- endif -%} - -{% if subpackages %} - Subpackages: - - .. toctree:: - :maxdepth: 1 -{% for item in subpackages %} - {{ fullname }}.{{ item }} - {%- endfor %} - {%- endif %} - -{% if members %} - Summary - ------- - - {%- if exceptions %} - - Exceptions: - - .. autosummary:: - :nosignatures: -{% for item in exceptions %} - {{ item }} -{%- endfor %} - {%- endif %} - - {%- if classes %} - - Classes: - - .. autosummary:: - :nosignatures: -{% for item in classes %} - {{ item }} -{%- endfor %} - {%- endif %} - - {%- if functions %} - - Functions: - - .. autosummary:: - :nosignatures: -{% for item in functions %} - {{ item }} -{%- endfor %} - {%- endif %} -{%- endif %} - - {%- if data %} - - Data: - - .. autosummary:: - :nosignatures: -{% for item in data %} - {{ item }} -{%- endfor %} - {%- endif %} - -{% if all_refs %} - ``__all__``: {{ all_refs|join(", ") }} -{%- endif %} - - -{% if members %} - Reference - --------- - -{%- endif %} diff --git a/lmnet/docs/source/blocks.rst b/lmnet/docs/source/blocks.rst deleted file mode 100644 index 631ffed12..000000000 --- a/lmnet/docs/source/blocks.rst +++ /dev/null @@ -1,29 +0,0 @@ -blocks module -============= - -.. currentmodule:: blocks - -.. automodule:: blocks - :members: darknet, dorefa_darknet, lmnet_block - :undoc-members: - :show-inheritance: - :member-order: bysource - - Summary - ------- - - Functions: - - .. autosummary:: - :nosignatures: - - darknet - dorefa_darknet - lmnet_block - - - - - - Reference - --------- diff --git a/lmnet/docs/source/conf.py b/lmnet/docs/source/conf.py deleted file mode 100644 index 0fc603158..000000000 --- a/lmnet/docs/source/conf.py +++ /dev/null @@ -1,368 +0,0 @@ -# -*- coding: utf-8 -*- -# -# lmnet documentation build configuration file, created by -# sphinx-quickstart on Tue Nov 21 19:14:48 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. - -import os -import sys - -import sphinx_rtd_theme - -sys.path.insert(0, '../../lmnet') - -# 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('.')) - -# -- 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.autosummary', - 'sphinx.ext.todo', - 'sphinx.ext.viewcode', - 'sphinx.ext.napoleon', - 'sphinx.ext.doctest', - 'sphinx.ext.mathjax', -] - -# 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 encoding of source files. -# source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'lmnet' -copyright = u'2017, Author' -author = u'Author' - -# 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 = u'' -# The full version, including alpha/beta/rc tags. -release = u'' - -# 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 = 'en' - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# 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', '_templates'] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# 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 = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - -# 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 = 'alabaster' - -html_theme = "sphinx_rtd_theme" - -html_theme_path = [sphinx_rtd_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 themes here, relative to this directory. -# html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -# 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 - -# The name of an image file (relative to this directory) to use as a favicon of -# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# 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, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# 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 = [] - -# 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' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_domain_indices = True - -# If false, no index is generated. -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' -# html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# Now only 'ja' uses this config value -# html_search_options = {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -# html_search_scorer = 'scorer.js' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'lmnetdoc' - -# -- 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, 'lmnet.tex', u'lmnet Documentation', - u'Author', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True - - -# -- 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, 'lmnet', u'lmnet Documentation', - [author], 1) -] - -# If true, show URL addresses after external links. -# man_show_urls = False - - -# -- 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, 'lmnet', u'lmnet Documentation', - author, 'lmnet', 'One line description of project.', - 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is generated. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False - - -# -- Options for Epub output ---------------------------------------------- - -# Bibliographic Dublin Core info. -epub_title = project -epub_author = author -epub_publisher = author -epub_copyright = copyright - -# The basename for the epub file. It defaults to the project name. -# epub_basename = project - -# The HTML theme for the epub output. Since the default themes are not -# optimized for small screen space, using the same theme for HTML and epub -# output is usually not wise. This defaults to 'epub', a theme designed to save -# visual space. -# epub_theme = 'epub' - -# The language of the text. It defaults to the language option -# or 'en' if the language is not set. -# epub_language = '' - -# The scheme of the identifier. Typical schemes are ISBN or URL. -# epub_scheme = '' - -# The unique identifier of the text. This can be a ISBN number -# or the project homepage. -# epub_identifier = '' - -# A unique identification for the text. -# epub_uid = '' - -# A tuple containing the cover image and cover page html template filenames. -# epub_cover = () - -# A sequence of (type, uri, title) tuples for the guide element of content.opf. -# epub_guide = () - -# HTML files that should be inserted before the pages created by sphinx. -# The format is a list of tuples containing the path and title. -# epub_pre_files = [] - -# HTML files that should be inserted after the pages created by sphinx. -# The format is a list of tuples containing the path and title. -# epub_post_files = [] - -# A list of files that should not be packed into the epub file. -epub_exclude_files = ['search.html'] - -# The depth of the table of contents in toc.ncx. -# epub_tocdepth = 3 - -# Allow duplicate toc entries. -# epub_tocdup = True - -# Choose between 'default' and 'includehidden'. -# epub_tocscope = 'default' - -# Fix unsupported image types using the Pillow. -# epub_fix_images = False - -# Scale large images. -# epub_max_image_width = 0 - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# epub_show_urls = 'inline' - -# If false, no index is generated. -# epub_use_index = True diff --git a/lmnet/docs/source/data_augmentor.rst b/lmnet/docs/source/data_augmentor.rst deleted file mode 100644 index 69a411ee6..000000000 --- a/lmnet/docs/source/data_augmentor.rst +++ /dev/null @@ -1,46 +0,0 @@ -data_augmentor module -===================== - -.. currentmodule:: data_augmentor - -.. automodule:: data_augmentor - :members: Blur, Brightness, Color, Contrast, Crop, FlipLeftRight, FlipTopBottom, Hue, Pad, RandomPatchCut, Rotate, SSDRandomCrop, affine_scale, color_filter - :undoc-members: - :show-inheritance: - :member-order: bysource - - Summary - ------- - - Classes: - - .. autosummary:: - :nosignatures: - - Blur - Brightness - Color - Contrast - Crop - FlipLeftRight - FlipTopBottom - Hue - Pad - RandomPatchCut - Rotate - SSDRandomCrop - - Functions: - - .. autosummary:: - :nosignatures: - - affine_scale - color_filter - - - - - - Reference - --------- diff --git a/lmnet/docs/source/data_processor.rst b/lmnet/docs/source/data_processor.rst deleted file mode 100644 index 1c20681cb..000000000 --- a/lmnet/docs/source/data_processor.rst +++ /dev/null @@ -1,35 +0,0 @@ -data_processor module -===================== - -.. currentmodule:: data_processor - -.. automodule:: data_processor - :members: Processor, Sequence, binarize - :undoc-members: - :show-inheritance: - :member-order: bysource - - Summary - ------- - - Classes: - - .. autosummary:: - :nosignatures: - - Processor - Sequence - - Functions: - - .. autosummary:: - :nosignatures: - - binarize - - - - - - Reference - --------- diff --git a/lmnet/docs/source/environment.rst b/lmnet/docs/source/environment.rst deleted file mode 100644 index 0f1aaa123..000000000 --- a/lmnet/docs/source/environment.rst +++ /dev/null @@ -1,28 +0,0 @@ -environment module -================== - -.. currentmodule:: environment - -.. automodule:: environment - :members: init, test_init - :undoc-members: - :show-inheritance: - :member-order: bysource - - Summary - ------- - - Functions: - - .. autosummary:: - :nosignatures: - - init - test_init - - - - - - Reference - --------- diff --git a/lmnet/docs/source/index.rst b/lmnet/docs/source/index.rst deleted file mode 100644 index 528ce02df..000000000 --- a/lmnet/docs/source/index.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. lmnet documentation master file, created by - sphinx-quickstart on Tue Dec 12 12:38:02 2017. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to lmnet's documentation! -================================= - -.. toctree:: - :maxdepth: 4 - :caption: Contents: - - blocks - data_augmentor - data_processor - environment - layers - networks - pre_processor - quantizations - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/lmnet/docs/source/layers.layers.rst b/lmnet/docs/source/layers.layers.rst deleted file mode 100644 index 7909093ef..000000000 --- a/lmnet/docs/source/layers.layers.rst +++ /dev/null @@ -1,34 +0,0 @@ -layers.layers module -==================== - -.. currentmodule:: layers.layers - -.. automodule:: layers.layers - :members: average_pooling2d, batch_norm, conv2d, fully_connected, leaky_relu, max_pool_with_argmax, max_pooling2d, unpool_with_argmax - :undoc-members: - :show-inheritance: - :member-order: bysource - - Summary - ------- - - Functions: - - .. autosummary:: - :nosignatures: - - average_pooling2d - batch_norm - conv2d - fully_connected - leaky_relu - max_pool_with_argmax - max_pooling2d - unpool_with_argmax - - - - - - Reference - --------- diff --git a/lmnet/docs/source/layers.quantization.rst b/lmnet/docs/source/layers.quantization.rst deleted file mode 100644 index 1f029b501..000000000 --- a/lmnet/docs/source/layers.quantization.rst +++ /dev/null @@ -1,32 +0,0 @@ -layers.quantization module -========================== - -.. currentmodule:: layers.quantization - -.. automodule:: layers.quantization - :members: dorefa_quantize_conv2d, generate_quantize_activation, generate_quantize_conv2d, generate_quantize_decorator, get_dorefa_quantizer, quantize_conv2d - :undoc-members: - :show-inheritance: - :member-order: bysource - - Summary - ------- - - Functions: - - .. autosummary:: - :nosignatures: - - dorefa_quantize_conv2d - generate_quantize_activation - generate_quantize_conv2d - generate_quantize_decorator - get_dorefa_quantizer - quantize_conv2d - - - - - - Reference - --------- diff --git a/lmnet/docs/source/layers.rst b/lmnet/docs/source/layers.rst deleted file mode 100644 index 30146db4b..000000000 --- a/lmnet/docs/source/layers.rst +++ /dev/null @@ -1,20 +0,0 @@ -layers package -============== - -.. automodule:: layers - - - - Submodules: - - .. toctree:: - :maxdepth: 1 - - layers.layers - layers.quantization - - - - - - diff --git a/lmnet/docs/source/make.bat b/lmnet/docs/source/make.bat deleted file mode 100644 index 51dec1484..000000000 --- a/lmnet/docs/source/make.bat +++ /dev/null @@ -1,284 +0,0 @@ -@ECHO OFF - -REM Command file for Sphinx documentation - -pushd %~dp0 - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set BUILDDIR=_build -set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . -set I18NSPHINXOPTS=%SPHINXOPTS% . -if NOT "%PAPER%" == "" ( - set ALLSPHINXOPTS=-D latex_elements.papersize=%PAPER% %ALLSPHINXOPTS% - set I18NSPHINXOPTS=-D latex_elements.papersize=%PAPER% %I18NSPHINXOPTS% -) - -if "%1" == "" goto help - -if "%1" == "help" ( - :help - echo.Please use `make ^` where ^ is one of - echo. html to make standalone HTML files - echo. dirhtml to make HTML files named index.html in directories - echo. singlehtml to make a single large HTML file - echo. pickle to make pickle files - echo. json to make JSON files - echo. htmlhelp to make HTML files and an HTML help project - echo. qthelp to make HTML files and a qthelp project - echo. devhelp to make HTML files and a Devhelp project - echo. epub to make an epub - echo. epub3 to make an epub3 - echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter - echo. text to make text files - echo. man to make manual pages - echo. texinfo to make Texinfo files - echo. gettext to make PO message catalogs - echo. changes to make an overview over all changed/added/deprecated items - echo. xml to make Docutils-native XML files - echo. pseudoxml to make pseudoxml-XML files for display purposes - echo. linkcheck to check all external links for integrity - echo. doctest to run all doctests embedded in the documentation if enabled - echo. coverage to run coverage check of the documentation if enabled - echo. dummy to check syntax errors of document sources - goto end -) - -if "%1" == "clean" ( - for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i - del /q /s %BUILDDIR%\* - goto end -) - - -REM Check if sphinx-build is available and fallback to Python version if any -%SPHINXBUILD% 1>NUL 2>NUL -if errorlevel 9009 goto sphinx_python -goto sphinx_ok - -:sphinx_python - -set SPHINXBUILD=python -m sphinx.__init__ -%SPHINXBUILD% 2> nul -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.http://sphinx-doc.org/ - exit /b 1 -) - -:sphinx_ok - - -if "%1" == "html" ( - %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/html. - goto end -) - -if "%1" == "dirhtml" ( - %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. - goto end -) - -if "%1" == "singlehtml" ( - %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. - goto end -) - -if "%1" == "pickle" ( - %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the pickle files. - goto end -) - -if "%1" == "json" ( - %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the JSON files. - goto end -) - -if "%1" == "htmlhelp" ( - %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run HTML Help Workshop with the ^ -.hhp project file in %BUILDDIR%/htmlhelp. - goto end -) - -if "%1" == "qthelp" ( - %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run "qcollectiongenerator" with the ^ -.qhcp project file in %BUILDDIR%/qthelp, like this: - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\lmnet.qhcp - echo.To view the help file: - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\lmnet.ghc - goto end -) - -if "%1" == "devhelp" ( - %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. - goto end -) - -if "%1" == "epub" ( - %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The epub file is in %BUILDDIR%/epub. - goto end -) - -if "%1" == "epub3" ( - %SPHINXBUILD% -b epub3 %ALLSPHINXOPTS% %BUILDDIR%/epub3 - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The epub3 file is in %BUILDDIR%/epub3. - goto end -) - -if "%1" == "latex" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "latexpdf" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - cd %BUILDDIR%/latex - make all-pdf - cd %~dp0 - echo. - echo.Build finished; the PDF files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "latexpdfja" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - cd %BUILDDIR%/latex - make all-pdf-ja - cd %~dp0 - echo. - echo.Build finished; the PDF files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "text" ( - %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The text files are in %BUILDDIR%/text. - goto end -) - -if "%1" == "man" ( - %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The manual pages are in %BUILDDIR%/man. - goto end -) - -if "%1" == "texinfo" ( - %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. - goto end -) - -if "%1" == "gettext" ( - %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The message catalogs are in %BUILDDIR%/locale. - goto end -) - -if "%1" == "changes" ( - %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes - if errorlevel 1 exit /b 1 - echo. - echo.The overview file is in %BUILDDIR%/changes. - goto end -) - -if "%1" == "linkcheck" ( - %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck - if errorlevel 1 exit /b 1 - echo. - echo.Link check complete; look for any errors in the above output ^ -or in %BUILDDIR%/linkcheck/output.txt. - goto end -) - -if "%1" == "doctest" ( - %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest - if errorlevel 1 exit /b 1 - echo. - echo.Testing of doctests in the sources finished, look at the ^ -results in %BUILDDIR%/doctest/output.txt. - goto end -) - -if "%1" == "coverage" ( - %SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage - if errorlevel 1 exit /b 1 - echo. - echo.Testing of coverage in the sources finished, look at the ^ -results in %BUILDDIR%/coverage/python.txt. - goto end -) - -if "%1" == "xml" ( - %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The XML files are in %BUILDDIR%/xml. - goto end -) - -if "%1" == "pseudoxml" ( - %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. - goto end -) - -if "%1" == "dummy" ( - %SPHINXBUILD% -b dummy %ALLSPHINXOPTS% %BUILDDIR%/dummy - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. Dummy builder generates no files. - goto end -) - -:end -popd diff --git a/lmnet/docs/source/modules.rst b/lmnet/docs/source/modules.rst deleted file mode 100644 index 47b3ccc5c..000000000 --- a/lmnet/docs/source/modules.rst +++ /dev/null @@ -1,14 +0,0 @@ -lmnet -===== - -.. toctree:: - :maxdepth: 4 - - blocks - data_augmentor - data_processor - environment - layers - networks - pre_processor - quantizations diff --git a/lmnet/docs/source/networks.base.rst b/lmnet/docs/source/networks.base.rst deleted file mode 100644 index e36cd5cf1..000000000 --- a/lmnet/docs/source/networks.base.rst +++ /dev/null @@ -1,27 +0,0 @@ -networks.base module -==================== - -.. currentmodule:: networks.base - -.. automodule:: networks.base - :members: BaseNetwork - :undoc-members: - :show-inheritance: - :member-order: bysource - - Summary - ------- - - Classes: - - .. autosummary:: - :nosignatures: - - BaseNetwork - - - - - - Reference - --------- diff --git a/lmnet/docs/source/networks.classification.base.rst b/lmnet/docs/source/networks.classification.base.rst deleted file mode 100644 index 4041bcd38..000000000 --- a/lmnet/docs/source/networks.classification.base.rst +++ /dev/null @@ -1,27 +0,0 @@ -networks.classification.base module -=================================== - -.. currentmodule:: networks.classification.base - -.. automodule:: networks.classification.base - :members: Base - :undoc-members: - :show-inheritance: - :member-order: bysource - - Summary - ------- - - Classes: - - .. autosummary:: - :nosignatures: - - Base - - - - - - Reference - --------- diff --git a/lmnet/docs/source/networks.classification.lmnet.rst b/lmnet/docs/source/networks.classification.lmnet.rst deleted file mode 100644 index cf1f81454..000000000 --- a/lmnet/docs/source/networks.classification.lmnet.rst +++ /dev/null @@ -1,27 +0,0 @@ -networks.classification.lmnet module -==================================== - -.. currentmodule:: networks.classification.lmnet - -.. automodule:: networks.classification.lmnet - :members: Lmnet - :undoc-members: - :show-inheritance: - :member-order: bysource - - Summary - ------- - - Classes: - - .. autosummary:: - :nosignatures: - - Lmnet - - - - - - Reference - --------- diff --git a/lmnet/docs/source/networks.classification.lmnet_quantize.rst b/lmnet/docs/source/networks.classification.lmnet_quantize.rst deleted file mode 100644 index 74455cb28..000000000 --- a/lmnet/docs/source/networks.classification.lmnet_quantize.rst +++ /dev/null @@ -1,27 +0,0 @@ -networks.classification.lmnet_quantize module -============================================= - -.. currentmodule:: networks.classification.lmnet_quantize - -.. automodule:: networks.classification.lmnet_quantize - :members: LmnetQuantize - :undoc-members: - :show-inheritance: - :member-order: bysource - - Summary - ------- - - Classes: - - .. autosummary:: - :nosignatures: - - LmnetQuantize - - - - - - Reference - --------- diff --git a/lmnet/docs/source/networks.classification.resnet.rst b/lmnet/docs/source/networks.classification.resnet.rst deleted file mode 100644 index 94010997e..000000000 --- a/lmnet/docs/source/networks.classification.resnet.rst +++ /dev/null @@ -1,27 +0,0 @@ -networks.classification.resnet module -===================================== - -.. currentmodule:: networks.classification.resnet - -.. automodule:: networks.classification.resnet - :members: Resnet - :undoc-members: - :show-inheritance: - :member-order: bysource - - Summary - ------- - - Classes: - - .. autosummary:: - :nosignatures: - - Resnet - - - - - - Reference - --------- diff --git a/lmnet/docs/source/networks.classification.rst b/lmnet/docs/source/networks.classification.rst deleted file mode 100644 index dd6ad2540..000000000 --- a/lmnet/docs/source/networks.classification.rst +++ /dev/null @@ -1,23 +0,0 @@ -networks.classification package -=============================== - -.. automodule:: networks.classification - - - - Submodules: - - .. toctree:: - :maxdepth: 1 - - networks.classification.base - networks.classification.lmnet - networks.classification.lmnet_quantize - networks.classification.resnet - networks.classification.vgg16 - - - - - - diff --git a/lmnet/docs/source/networks.classification.vgg16.rst b/lmnet/docs/source/networks.classification.vgg16.rst deleted file mode 100644 index 644a7fc7b..000000000 --- a/lmnet/docs/source/networks.classification.vgg16.rst +++ /dev/null @@ -1,27 +0,0 @@ -networks.classification.vgg16 module -==================================== - -.. currentmodule:: networks.classification.vgg16 - -.. automodule:: networks.classification.vgg16 - :members: Vgg16Network - :undoc-members: - :show-inheritance: - :member-order: bysource - - Summary - ------- - - Classes: - - .. autosummary:: - :nosignatures: - - Vgg16Network - - - - - - Reference - --------- diff --git a/lmnet/docs/source/networks.lmnet_multi.rst b/lmnet/docs/source/networks.lmnet_multi.rst deleted file mode 100644 index eda325b5a..000000000 --- a/lmnet/docs/source/networks.lmnet_multi.rst +++ /dev/null @@ -1,34 +0,0 @@ -networks.lmnet_multi module -=========================== - -.. currentmodule:: networks.lmnet_multi - -.. automodule:: networks.lmnet_multi - :members: LmnetMulti, safe_log - :undoc-members: - :show-inheritance: - :member-order: bysource - - Summary - ------- - - Classes: - - .. autosummary:: - :nosignatures: - - LmnetMulti - - Functions: - - .. autosummary:: - :nosignatures: - - safe_log - - - - - - Reference - --------- diff --git a/lmnet/docs/source/networks.rst b/lmnet/docs/source/networks.rst deleted file mode 100644 index 41492702e..000000000 --- a/lmnet/docs/source/networks.rst +++ /dev/null @@ -1,26 +0,0 @@ -networks package -================ - -.. automodule:: networks - - - - Submodules: - - .. toctree:: - :maxdepth: 1 - - networks.base - networks.lmnet_multi - Subpackages: - - .. toctree:: - :maxdepth: 1 - - networks.classification - - - - - - diff --git a/lmnet/docs/source/pre_processor.rst b/lmnet/docs/source/pre_processor.rst deleted file mode 100644 index 88b1b1a69..000000000 --- a/lmnet/docs/source/pre_processor.rst +++ /dev/null @@ -1,45 +0,0 @@ -pre_processor module -==================== - -.. currentmodule:: pre_processor - -.. automodule:: pre_processor - :members: DivideBy255, LetterBoxes, PerImageLinearQuantize, PerImageStandardization, Resize, ResizeWithGtBoxes, ResizeWithMask, per_image_linear_quantize, per_image_standardization, resize, resize_keep_ratio_with_gt_boxes, resize_with_gt_boxes, square - :undoc-members: - :show-inheritance: - :member-order: bysource - - Summary - ------- - - Classes: - - .. autosummary:: - :nosignatures: - - DivideBy255 - LetterBoxes - PerImageLinearQuantize - PerImageStandardization - Resize - ResizeWithGtBoxes - ResizeWithMask - - Functions: - - .. autosummary:: - :nosignatures: - - per_image_linear_quantize - per_image_standardization - resize - resize_keep_ratio_with_gt_boxes - resize_with_gt_boxes - square - - - - - - Reference - --------- diff --git a/lmnet/docs/source/quantizations.binary.rst b/lmnet/docs/source/quantizations.binary.rst deleted file mode 100644 index 5f48855a1..000000000 --- a/lmnet/docs/source/quantizations.binary.rst +++ /dev/null @@ -1,28 +0,0 @@ -quantizations.binary module -=========================== - -.. currentmodule:: quantizations.binary - -.. automodule:: quantizations.binary - :members: binary_channel_wise_mean_scaling_quantizer, binary_mean_scaling_quantizer - :undoc-members: - :show-inheritance: - :member-order: bysource - - Summary - ------- - - Functions: - - .. autosummary:: - :nosignatures: - - binary_channel_wise_mean_scaling_quantizer - binary_mean_scaling_quantizer - - - - - - Reference - --------- diff --git a/lmnet/docs/source/quantizations.linear.rst b/lmnet/docs/source/quantizations.linear.rst deleted file mode 100644 index cfe9d025b..000000000 --- a/lmnet/docs/source/quantizations.linear.rst +++ /dev/null @@ -1,27 +0,0 @@ -quantizations.linear module -=========================== - -.. currentmodule:: quantizations.linear - -.. automodule:: quantizations.linear - :members: linear_mid_tread_half_quantizer - :undoc-members: - :show-inheritance: - :member-order: bysource - - Summary - ------- - - Functions: - - .. autosummary:: - :nosignatures: - - linear_mid_tread_half_quantizer - - - - - - Reference - --------- diff --git a/lmnet/docs/source/quantizations.rst b/lmnet/docs/source/quantizations.rst deleted file mode 100644 index bde66193a..000000000 --- a/lmnet/docs/source/quantizations.rst +++ /dev/null @@ -1,22 +0,0 @@ -quantizations package -===================== - -.. automodule:: quantizations - - - - Submodules: - - .. toctree:: - :maxdepth: 1 - - quantizations.binary - quantizations.linear - quantizations.ternary - - - - - ``__all__``: :func:`binary_channel_wise_mean_scaling_quantizer `, :func:`binary_mean_scaling_quantizer `, :func:`linear_mid_tread_half_quantizer `, :func:`ttq_weight_quantizer `, :func:`twn_weight_quantizer ` - - diff --git a/lmnet/docs/source/quantizations.ternary.rst b/lmnet/docs/source/quantizations.ternary.rst deleted file mode 100644 index c4cbc910c..000000000 --- a/lmnet/docs/source/quantizations.ternary.rst +++ /dev/null @@ -1,28 +0,0 @@ -quantizations.ternary module -============================ - -.. currentmodule:: quantizations.ternary - -.. automodule:: quantizations.ternary - :members: ttq_weight_quantizer, twn_weight_quantizer - :undoc-members: - :show-inheritance: - :member-order: bysource - - Summary - ------- - - Functions: - - .. autosummary:: - :nosignatures: - - ttq_weight_quantizer - twn_weight_quantizer - - - - - - Reference - ---------