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

* footer copyright fix, sidenav tweaks, misc doc edits
* icon for pypi presentation
* incorrect product referenced in release list

Author: jeanniefinks

README.md

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 -->
 
-# ![icon for SparseMl](https://github.com/neuralmagic/sparseml/blob/main/docs/icon-sparseml.png) SparseML
+# ![icon for SparseMl](https://raw.githubusercontent.com/neuralmagic/sparseml/main/docs/source/icon-sparseml.png) SparseML
 
 ### Libraries for state-of-the-art deep neural network optimization algorithms, enabling simple pipelines integration with a few lines of code
 
@@ -23,12 +23,12 @@ 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/sparseml/">
-        <img alt="Documentation" src="https://img.shields.io/website/http/neuralmagic.com/sparseml/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/sparseml/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/sparseml/releases">
         <img alt="GitHub release" src="https://img.shields.io/github/release/neuralmagic/sparseml.svg?style=for-the-badge" height=25>
     </a>
-    <a href="https://github.com/neuralmagic.com/sparseml/blob/main/CODE_OF_CONDUCT.md">
+    <a href="https://github.com/neuralmagic/sparseml/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>
     </a>
      <a href="https://www.youtube.com/channel/UCo8dO_WMGYbWCRnj_Dxr4EA">
@@ -163,7 +163,7 @@ The integration is done using the `ScheduledModifierManager` class which can be
 This class handles modifying the TensorFlow graph for the desired optimizations.
 With this setup, the training process can then be modified as desired to optimize the model.
 
-#### Estimator-based pipelines
+#### Estimator-Based pipelines
 
 Estimator-based pipelines are simpler to integrate with as compared to session-based pipelines.
 The `ScheduledModifierManager` can override the necessary callbacks in the estimator to modify the graph using the `modify_estimator` function.
@@ -180,7 +180,7 @@ manager.modify_estimator(estimator, steps_per_epoch=num_train_batches)
 # Normal estimator training code...
 ```
 
-#### Session-based pipelines
+#### Session-Based pipelines
 
 Session-based pipelines need a little bit more as compared to estimator-based pipelines; however,
 it is still designed to require only a few lines of code for integration.
@@ -321,15 +321,15 @@ TensorFlow V1:
 
 ```bash
 pip install sparseml[tf_v1]
-``` 
+```
 
 TensorFlow V1 with GPU operations enabled:
+
 ```bash
 pip install sparseml[tf_v1_gpu]
-``` 
-Depending on your device and CUDA version, you may need to install additional
-dependencies for using TensorFlow V1 with GPU operations.  You can find these
-steps [here](https://www.tensorflow.org/install/gpu#older_versions_of_tensorflow).
+```
+
+Depending on your device and CUDA version, you may need to install additional dependencies for using TensorFlow V1 with GPU operations.  You can find these steps [here](https://www.tensorflow.org/install/gpu#older_versions_of_tensorflow).
 
 ## Resources and Learning More
 

docs/source/conf.py

@@ -20,7 +20,7 @@
 
 project = "SparseML"
 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"

docs/source/index.rst

@@ -23,16 +23,16 @@ enabling simple pipelines integration with a few lines of code
 .. raw:: html
 
     <div style="margin-bottom:16px;">
-        <a href="https://github.com/neuralmagic/sparseml/blob/master/LICENSE">
+        <a href="https://github.com/neuralmagic/sparseml/blob/main/LICENSE">
             <img alt="GitHub" src="https://img.shields.io/github/license/neuralmagic/sparseml.svg?color=purple&style=for-the-badge" height=25 style="margin-bottom:4px;">
         </a>
         <a href="https://docs.neuralmagic.com/sparseml/index.html">
-            <img alt="Documentation" src="https://img.shields.io/website/http/neuralmagic.com/sparseml/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/sparseml/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/sparseml/releases">
             <img alt="GitHub release" src="https://img.shields.io/github/release/neuralmagic/sparseml.svg?style=for-the-badge" height=25 style="margin-bottom:4px;">
         </a>
-        <a href="https://github.com/neuralmagic.com/sparseml/blob/master/CODE_OF_CONDUCT.md">
+        <a href="https://github.com/neuralmagic/sparseml/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">
@@ -63,7 +63,7 @@ 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 />`_:
+- `SparseZoo <https://github.com/neuralmagic/sparsezoo />`_:
   Neural network model repository for highly sparse models and optimization recipes
 - `Sparsify <https://github.com/neuralmagic/sparsify />`_:
   Easy-to-use autoML interface to optimize deep neural networks for
@@ -73,7 +73,6 @@ 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/ />`_,
@@ -84,8 +83,8 @@ Release History
 ===============
 
 Official builds are hosted on PyPi
-- stable: `sparsezoo <https://pypi.org/project/sparseml/ />`_
-- nightly (dev): `sparsezoo-nightly <https://pypi.org/project/sparseml-nightly/ />`_
+- stable: `sparseml <https://pypi.org/project/sparseml/ />`_
+- nightly (dev): `sparseml-nightly <https://pypi.org/project/sparseml-nightly/ />`_
 
 Additionally, more information can be found via
 `GitHub Releases <https://github.com/neuralmagic/sparseml/releases />`_.
@@ -103,3 +102,11 @@ Additionally, more information can be found via
     :caption: API
 
     api/sparseml
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Help and Support
+
+    `Bugs, Feature Requests <https://github.com/neuralmagic/sparseml/discussions>`_ 
+    `Support, General Q&A <https://github.com/neuralmagic/sparseml/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
+pip install sparseml
 ```
 
-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/sparseml/tree/main/scripts), [notebooks](https://github.com/neuralmagic/sparseml/tree/main/notebooks), or [examples](https://github.com/neuralmagic/sparseml/tree/main/examples) clone the repository and install any additional dependencies as required.