Add structure and pages to sphinx (neuralmagic#17)

* Add structure and pages to sphinx

* make style and quality

Author: markurtz

.gitignore

@@ -1,6 +1,4 @@
-# NM Studio
-/server/model_paths.json
-
+/docs/source/api/*.rst
 
 npm-debug.log
 yarn-error.log

Makefile

@@ -6,7 +6,7 @@ PYCHECKGLOBS := 'examples/**/*.py' 'scripts/**/*.py' 'src/**/*.py' 'tests/**/*.p
 JSCHECKDIRS := src public
 JSCHECKGLOBS := 'public/**/*.html' 'public/**/*.js' 'public/**/*.css' 'src/**/*.html' 'src/**/*.jsx' 'tests/**/*.jsx'
 DOCDIR := docs
-MDCHECKGLOBS := 'docs/**/*.md' 'examples/**/*.md' 'notebooks/**/*.md' 'scripts/**/*.md'
+MDCHECKGLOBS := 'docs/**/*.md' 'docs/**/*.rst' 'examples/**/*.md' 'notebooks/**/*.md' 'scripts/**/*.md'
 MDCHECKFILES := CODE_OF_CONDUCT.md CONTRIBUTING.md DEVELOPING.md README.md
 
 # run checks on all files for the repo
@@ -37,8 +37,8 @@ test:
 
 # create docs
 docs:
-	sphinx-apidoc -o "$(DOCDIR)/source/" src/sparsify;
-	cd $(DOCDIR) && $(MAKE) html;
+	export SPARSEML_IGNORE_TFV1="True"; sphinx-apidoc -o "$(DOCDIR)/source/api" src/sparsify;
+	export SPARSEML_IGNORE_TFV1="True"; cd $(DOCDIR) && $(MAKE) html;
 
 # creates wheel file
 build:

README.md

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 -->
 
-# ![icon for Sparsify](https://github.com/neuralmagic/sparsify/blob/main/docs/icon-sparsify.png) Sparsify
+# ![icon for Sparsify](https://github.com/neuralmagic/sparsify/blob/main/docs/source/icon-sparsify.png) Sparsify
 
 ### Easy-to-use autoML interface to optimize deep neural networks for better inference performance and a smaller footprint
 

docs/README.md

@@ -18,13 +18,16 @@
 
 # -- Project information -----------------------------------------------------
 
-project = "sparsify"
-copyright = "2020, Neural Magic"
+project = "Sparsify"
+copyright = (
+    "Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved. "
+    'Licensed under the Apache License, Version 2.0 (the "License")'
+)
 author = "Neural Magic"
 
 # The full version, including alpha/beta/rc tags
-version = ""
-release = "1.0.9"
+version = "0.1"
+release = "0.1.0"
 
 
 # -- General configuration ---------------------------------------------------
@@ -34,12 +37,17 @@
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
-    "sphinx.ext.intersphinx",
+    "sphinx.ext.coverage",
+    "sphinx.ext.extlinks",
+    "sphinx.ext.githubpages",
     "sphinx.ext.ifconfig",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
-    "sphinx.ext.githubpages",
-    "rinoh.frontend.sphinx",
+    "sphinx_copybutton",
+    "sphinx_markdown_tables",
     "sphinx_rtd_theme",
+    "recommonmark",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -48,11 +56,11 @@
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
-# source_suffix = ['.rst', '.md']
-source_suffix = ".rst"
+source_suffix = [".rst", ".md"]
+# source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = "sparsify"
+master_doc = "index"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -76,6 +84,7 @@
 # a list of builtin themes.
 #
 html_theme = "sphinx_rtd_theme"
+html_logo = "icon-sparsify.png"
 
 # 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,
@@ -92,6 +101,8 @@
 #
 # html_sidebars = {}
 
+html_favicon = "favicon.ico"
+
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
@@ -101,30 +112,24 @@
 # -- Options for LaTeX output ------------------------------------------------
 
 latex_elements = {
-    "papersize": "letterpaper",
-    "pointsize": "10pt",
-    "preamble": "",
-    "figure_align": "htbp",
+    # "papersize": "letterpaper",
+    # "pointsize": "10pt",
+    # "preamble": "",
+    # "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,
-        "Sparsify_API.tex",
-        "Sparsify API",
-        "Neural Magic",
-        "manual",
-    ),
+    (master_doc, "sparsify.tex", "Sparsify Documentation", [author], "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, "sparsifyapi", "Sparsify API Documentation", [author], 1)]
+man_pages = [(master_doc, "sparsify", "Sparsify Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output ----------------------------------------------
@@ -135,11 +140,14 @@
 texinfo_documents = [
     (
         master_doc,
-        "",
-        "Sparsify API Documentation",
+        "sparsify",
+        "Sparsify Documentation",
         author,
-        "Sparsify_API",
-        "API implementations designed for ML frameworks to enable better performance in the Neural Magic system.",
+        "sparsify",
+        (
+            "Easy-to-use autoML interface to optimize deep neural networks for better "
+            "inference performance and a smaller footprint"
+        ),
         "Miscellaneous",
     ),
 ]
@@ -163,7 +171,7 @@
 # epub_uid = ''
 
 # A list of files that should not be packed into the epub file.
-epub_exclude_files = ["search.html"]
+epub_exclude_files = []
 
 
 # -- Extension configuration -------------------------------------------------

docs/source/api/.gitkeep

@@ -0,0 +1,99 @@
+..
+    Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved.
+    
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+    
+       http://www.apache.org/licenses/LICENSE-2.0
+    
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+===================
+Sparsify |version|
+===================
+
+Neural network model repository for highly sparse models and optimization recipes.
+
+.. raw:: html
+
+    <div style="margin-bottom:16px;">
+        <a href="https://github.com/neuralmagic/sparsify/blob/master/LICENSE">
+            <img alt="GitHub" src="https://img.shields.io/github/license/neuralmagic/sparsify.svg?color=purple&style=for-the-badge" height=25 style="margin-bottom:4px;">
+        </a>
+        <a href="https://docs.neuralmagic.com/sparsify/index.html">
+            <img alt="Documentation" src="https://img.shields.io/website/http/neuralmagic.com/sparsify/index.html.svg?down_color=red&down_message=offline&up_message=online&style=for-the-badge" height=25 style="margin-bottom:4px;">
+        </a>
+        <a href="https://github.com/neuralmagic/sparsify/releases">
+            <img alt="GitHub release" src="https://img.shields.io/github/release/neuralmagic/sparsify.svg?style=for-the-badge" height=25 style="margin-bottom:4px;">
+        </a>
+        <a href="https://github.com/neuralmagic.com/sparsify/blob/master/CODE_OF_CONDUCT.md">
+            <img alt="Contributor Covenant" src="https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg?color=yellow&style=for-the-badge" height=25 style="margin-bottom:4px;">
+        </a>
+         <a href="https://www.youtube.com/channel/UCo8dO_WMGYbWCRnj_Dxr4EA">
+            <img src="https://img.shields.io/badge/-YouTube-red?&style=for-the-badge&logo=youtube&logoColor=white" height=25 style="margin-bottom:4px;">
+        </a>
+         <a href="https://medium.com/limitlessai">
+            <img src="https://img.shields.io/badge/medium-%2312100E.svg?&style=for-the-badge&logo=medium&logoColor=white" height=25 style="margin-bottom:4px;">
+        </a>
+        <a href="https://twitter.com/neuralmagic">
+            <img src="https://img.shields.io/twitter/follow/neuralmagic?color=darkgreen&label=Follow&style=social" height=25 style="margin-bottom:4px;">
+        </a>
+     </div>
+
+Overview
+========
+
+Sparsify is a deep learning autoML tool that simplifies the model optimization process to rapidly achieve the best combination of size, speed, and accuracy on any deep learning model. Sparsify optimizes and benchmarks models informed by industry research insights for ML practitioners, including ML engineers and operators, who need to deploy performant deep learning models fast and at scale. Sparsify shows visual performance potential for your model, including a sliding scale between performance and loss sensitivity, ultimately speeding up the model optimization process from weeks to minutes.
+
+This repository contains the package to locally launch Sparsify where you can create projects to load and optimize your deep learning models. At the end, you can export optimization recipes to integrate with your training workflow.
+
+Related Products
+================
+
+- `DeepSparse <https://github.com/neuralmagic/deepsparse />`_:
+  CPU inference engine that delivers unprecedented performance for sparse models
+- `Sparse Zoo <https://github.com/neuralmagic/sparsezoo />`_:
+  Neural network model repository for highly sparse models and optimization recipes
+- `SparseML <https://github.com/neuralmagic/sparseml />`_:
+  Libraries for state-of-the-art deep neural network optimization algorithms,
+  enabling simple pipelines integration with a few lines of code
+
+Resources and Learning More
+===========================
+
+- `SparseZoo Documentation <https://docs.neuralmagic.com/sparsezoo/ />`_
+- `SparseML Documentation <https://docs.neuralmagic.com/sparseml/ />`_
+- `Sparsify Documentation <https://docs.neuralmagic.com/sparsify/ />`_
+- `DeepSparse Documentation <https://docs.neuralmagic.com/deepsparse/ />`_
+- `Neural Magic Blog <https://www.neuralmagic.com/blog/ />`_,
+  `Resources <https://www.neuralmagic.com/resources/ />`_,
+  `Website <https://www.neuralmagic.com/ />`_
+
+Release History
+===============
+
+Official builds are hosted on PyPi
+- stable: `sparsify <https://pypi.org/project/sparsify/ />`_
+- nightly (dev): `sparsify-nightly <https://pypi.org/project/sparsify-nightly/ />`_
+
+Additionally, more information can be found via
+`GitHub Releases <https://github.com/neuralmagic/sparsify/releases />`_.
+
+.. toctree::
+    :maxdepth: 3
+    :caption: General
+
+    quicktour
+    installation
+    userguide/index
+
+.. toctree::
+    :maxdepth: 2
+    :caption: API
+
+    api/sparsify

docs/source/conf.py

@@ -0,0 +1,32 @@
+<!--
+Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+### Installation
+
+This repository is tested on Python 3.6+, and Linux/Debian systems.
+It is recommended to install in a [virtual environment](https://docs.python.org/3/library/venv.html) 
+to keep your system in order.
+
+Install with pip using:
+
+```bash
+pip install sparsify
+```
+
+Then if you would like to explore any of the [scripts](https://github.com/neuralmagic/sparsify/tree/main/scripts), 
+[notebooks](https://github.com/neuralmagic/sparsify/tree/main/notebooks), 
+or [examples](https://github.com/neuralmagic/sparsify/tree/main/examples)
+clone the repository and install any additional dependencies as required.