footer copyright fix, sidenav tweaks, icon url for pypi (#30)

- removed dupe of copyright config for docs footer
- added help and support to docs nav
- edited better url for repo icon and pypi
- misc text fixes

Author: jeanniefinks

README.md

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 -->
 
-# ![icon for SparseZoo](https://github.com/neuralmagic/sparsezoo/blob/main/docs/icon-sparsezoo.png) SparseZoo
+# ![icon for SparseZoo](https://raw.githubusercontent.com/neuralmagic/sparsezoo/main/docs/source/icon-sparsezoo.png) SparseZoo
 
 ### Neural network model repository for highly sparse models and optimization recipes
 
@@ -23,7 +23,7 @@ limitations under the License.
         <img alt="GitHub" src="https://img.shields.io/github/license/neuralmagic/comingsoon.svg?color=purple&style=for-the-badge" height=25>
     </a>
     <a href="https://docs.neuralmagic.com/sparsezoo/index.html">
-        <img alt="Documentation" src="https://img.shields.io/website/http/neuralmagic.com/sparsezoo/index.html.svg?down_color=red&down_message=offline&up_message=online&style=for-the-badge" height=25>
+        <img alt="Documentation" src="https://img.shields.io/website/http/docs.neuralmagic.com/sparsezoo/index.html.svg?down_color=red&down_message=offline&up_message=online&style=for-the-badge" height=25>
     </a>
     <a href="https://github.com/neuralmagic/sparsezoo/releases">
         <img alt="GitHub release" src="https://img.shields.io/github/release/neuralmagic/sparsezoo.svg?style=for-the-badge" height=25>
@@ -205,13 +205,13 @@ Install with pip using:
 pip install sparsezoo
 ```
 
-Then if you would like to explore any of the [scripts](https://github.com/neuralmagic/sparsezoo/blob/main/scripts/), [notebooks](https://github.com/neuralmagic/sparsezoo/blob/main/notebooks/), or [examples](https://github.com/neuralmagic/sparsezoo/blob/main/examples/)
+Then if you would like to explore any of the [scripts](https://github.com/neuralmagic/sparsezoo/blob/main/scripts/) or [notebooks](https://github.com/neuralmagic/sparsezoo/blob/main/notebooks/)
 clone the repository and install any additional dependencies as required.
 
 ## Available Models and Recipes
 
 A number of pre-trained baseline and optimized models across domains and sub domains are available and constantly being added.
-For an up to date list, please consult the [available models listing](https://github.com/neuralmagic/sparsezoo/blob/main/docs/available-models.md).
+For an up to date list, please consult the [available models listing](https://github.com/neuralmagic/sparsezoo/blob/main/docs/source/models.md).
 
 ## Resources and Learning More
 
@@ -223,7 +223,7 @@ For an up to date list, please consult the [available models listing](https://gi
 
 ## Contributing
 
-We appreciate contributions to the code, examples, and documentation as well as bug reports and feature requests![Learn how here](https://github.com/neuralmagic/sparsezoo/blob/main/CONTRIBUTING.md).
+We appreciate contributions to the code, examples, and documentation as well as bug reports and feature requests! [Learn how here](https://github.com/neuralmagic/sparsezoo/blob/main/CONTRIBUTING.md).
 
 ## Join the Community
 

docs/source/conf.py

@@ -18,9 +18,9 @@
 
 # -- Project information -----------------------------------------------------
 
-project = "Sparse Zoo"
+project = "SparseZoo"
 copyright = (
-    "Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved. "
+    "2021 - present / Neuralmagic, Inc. All Rights Reserved. "
     'Licensed under the Apache License, Version 2.0 (the "License")'
 )
 author = "Neural Magic"
@@ -122,14 +122,14 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, "sparsezoo.tex", "Sparse Zoo Documentation", [author], "manual",),
+    (master_doc, "sparsezoo.tex", "SparseZoo 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, "sparsezoo", "Sparse Zoo Documentation", [author], 1)]
+man_pages = [(master_doc, "sparsezoo", "SparseZoo Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output ----------------------------------------------
@@ -141,7 +141,7 @@
     (
         master_doc,
         "sparsezoo",
-        "Sparse Zoo Documentation",
+        "SparseZoo Documentation",
         author,
         "sparsezoo",
         (

docs/source/index.rst

@@ -17,21 +17,21 @@
 SparseZoo |version|
 ===================
 
-Neural network model repository for highly sparse models and optimization recipes.
+Neural network model repository for highly sparse models and optimization recipes
 
 .. raw:: html
 
     <div style="margin-bottom:16px;">
-        <a href="https://github.com/neuralmagic/sparsezoo/blob/master/LICENSE">
+        <a href="https://github.com/neuralmagic/sparsezoo/blob/main/LICENSE">
             <img alt="GitHub" src="https://img.shields.io/github/license/neuralmagic/sparsezoo.svg?color=purple&style=for-the-badge" height=25 style="margin-bottom:4px;">
         </a>
         <a href="https://docs.neuralmagic.com/sparsezoo/index.html">
-            <img alt="Documentation" src="https://img.shields.io/website/http/neuralmagic.com/sparsezoo/index.html.svg?down_color=red&down_message=offline&up_message=online&style=for-the-badge" height=25 style="margin-bottom:4px;">
+            <img alt="Documentation" src="https://img.shields.io/website/http/docs.neuralmagic.com/sparsezoo/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/sparsezoo/releases">
             <img alt="GitHub release" src="https://img.shields.io/github/release/neuralmagic/sparsezoo.svg?style=for-the-badge" height=25 style="margin-bottom:4px;">
         </a>
-        <a href="https://github.com/neuralmagic.com/sparsezoo/blob/master/CODE_OF_CONDUCT.md">
+        <a href="https://github.com/neuralmagic.com/sparsezoo/blob/main/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">
@@ -77,7 +77,6 @@ Related Products
 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/ />`_
@@ -109,3 +108,11 @@ Additionally, more information can be found via
     :caption: API
 
     api/sparsezoo
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Help and Support
+
+    `Bugs, Feature Requests <https://github.com/neuralmagic/sparsezoo/discussions>`_ 
+    `Support, General Q&A <https://github.com/neuralmagic/sparsezoo/issues>`_ 
+   

docs/source/installation.md

@@ -17,16 +17,12 @@ 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.
+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 sparsezoo
 ```
 
-Then if you would like to explore any of the [scripts](https://github.com/neuralmagic/sparsezoo/tree/main/scripts), 
-[notebooks](https://github.com/neuralmagic/sparsezoo/tree/main/notebooks), 
-or [examples](https://github.com/neuralmagic/sparsezoo/tree/main/examples)
-clone the repository and install any additional dependencies as required.
+Then if you would like to explore any of the [scripts](https://github.com/neuralmagic/sparsezoo/tree/main/scripts) or [notebooks](https://github.com/neuralmagic/sparsezoo/tree/main/notebooks) clone the repository and install any additional dependencies as required.

docs/source/quicktour.md

@@ -56,6 +56,7 @@ The Python APIs respect this format enabling you to search and download models.
 Some code examples are given below.
 
 #### Searching the Zoo
+
 ```python
 from sparsezoo import Zoo
 
@@ -64,6 +65,7 @@ print(models)
 ```
 
 #### Common Models
+
 ```python
 from sparsezoo.models.classification import resnet_50
 
@@ -74,6 +76,7 @@ print(model.onnx_file.downloaded_path())
 ```
 
 #### Searching Optimized Versions
+
 ```python
 from sparsezoo import Zoo
 from sparsezoo.models.classification import resnet_50
@@ -89,8 +92,7 @@ print(optimized_models)
 In addition to the Python APIs, a console script entry point is installed with the package `sparsezoo`.
 This enables easy interaction straight from your console/terminal.
 Note, for some environments the console scripts cannot install properly.
-If this happens for your system and the sparsezoo command is not available, 
-`scripts/sparsezoo.py` may be used in its place. 
+If this happens for your system and the sparsezoo command is not available, `scripts/sparsezoo.py` may be used in its place.
 
 ```shell script
 sparsezoo -h
@@ -99,29 +101,34 @@ sparsezoo -h
 #### Searching
 
 Search command help
+
 ```shell script
 sparsezoo search -h
 ```
 
 <br>Searching for all classification models in the computer vision domain
+
 ```shell script
 sparsezoo search --domain cv --sub-domain classification \
     --architecture resnet_v1 --sub-architecture 50
 ```
 
 <br>Searching for all ResNet-50 models
+
 ```shell script
 sparsezoo search --domain cv --sub-domain classification
 ```
 
 #### Downloading
 
 Download command help
+
 ```shell script
 sparsezoo download -h
 ```
 
 <br>Download ResNet-50 Model
+
 ```shell script
 sparsezoo download --domain cv --sub-domain classification \
     --architecture resnet_v1 --sub-architecture 50 \
@@ -130,6 +137,7 @@ sparsezoo download --domain cv --sub-domain classification \
 ```
 
 <br>Download pruned and quantized ResNet-50 Model
+
 ```shell script
 sparsezoo download --domain cv --sub-domain classification \
     --architecture resnet_v1 --sub-architecture 50 \