From 863803324c5a4f48fb7f46ce3a8d2270fcf30c2c Mon Sep 17 00:00:00 2001 From: "Jeannie Finks (NM)" <74554921+jeanniefinks@users.noreply.github.com> Date: Tue, 2 Feb 2021 19:18:04 -0500 Subject: [PATCH 1/2] footer copyright fix, sidenav tweaks, misc doc edits --- README.md | 10 +++++----- docs/source/conf.py | 10 +++++----- docs/source/index.rst | 17 ++++++++++++----- docs/source/installation.md | 8 ++------ docs/source/quicktour.md | 12 ++++++++++-- 5 files changed, 34 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 122d81d3..b29128b7 100644 --- a/README.md +++ b/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. GitHub - Documentation + Documentation GitHub release @@ -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 diff --git a/docs/source/conf.py b/docs/source/conf.py index fbac4cf1..796aae08 100644 --- a/docs/source/conf.py +++ b/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", ( diff --git a/docs/source/index.rst b/docs/source/index.rst index abf65e24..2902d9a2 100644 --- a/docs/source/index.rst +++ b/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
- + GitHub - Documentation + Documentation GitHub release - + Contributor Covenant @@ -77,7 +77,6 @@ Related Products Resources and Learning More =========================== -- `SparseZoo Documentation `_ - `SparseML Documentation `_ - `Sparsify Documentation `_ - `DeepSparse Documentation `_ @@ -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 `_ + `Support, General Q&A `_ + \ No newline at end of file diff --git a/docs/source/installation.md b/docs/source/installation.md index afb770eb..85ccfa83 100644 --- a/docs/source/installation.md +++ b/docs/source/installation.md @@ -17,8 +17,7 @@ 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: @@ -26,7 +25,4 @@ Install with pip using: 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. \ No newline at end of file +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. diff --git a/docs/source/quicktour.md b/docs/source/quicktour.md index ee3e560a..78cbc638 100644 --- a/docs/source/quicktour.md +++ b/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,17 +101,20 @@ sparsezoo -h #### Searching Search command help + ```shell script sparsezoo search -h ```
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 ```
Searching for all ResNet-50 models + ```shell script sparsezoo search --domain cv --sub-domain classification ``` @@ -117,11 +122,13 @@ sparsezoo search --domain cv --sub-domain classification #### Downloading Download command help + ```shell script sparsezoo download -h ```
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 \ ```
Download pruned and quantized ResNet-50 Model + ```shell script sparsezoo download --domain cv --sub-domain classification \ --architecture resnet_v1 --sub-architecture 50 \ From f2e90229462e7deb570a76a26c00da32a8403f9f Mon Sep 17 00:00:00 2001 From: "Jeannie Finks (NM)" <74554921+jeanniefinks@users.noreply.github.com> Date: Tue, 2 Feb 2021 19:22:26 -0500 Subject: [PATCH 2/2] url typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b29128b7..391b1b61 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ See the License for the specific language governing permissions and limitations under the License. --> -# ![icon for SparseZoo]((https://raw.githubusercontent.com/neuralmagic/sparsezoo/main/docs/source/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