Skip to content

Commit

Permalink
Update README.md, index.rst, CONTRIB, CONDUCT (neuralmagic#131)
Browse files Browse the repository at this point in the history
* Update README.md

- replacing absolute .md models and recipes links w/ html links
- updating Contributor Covenant 2.0 to 2.1
- retiring discourse links
- Reformatting links that have punctuation outside the links to be inclusive of punctuation within the links (e.g., periods or commas)

* Update CODE_OF_CONDUCT.md

contributor-covenant updated from 2.0 to 2.1

* Update models.md

added formatting

* Update index.rst

- updating SparseZoo Repo to go to UI website instead of GitHub
- removing Discourse link

* Update CONTRIBUTING.md

removing Discourse
  • Loading branch information
jeanniefinks authored Feb 23, 2022
1 parent 15e7ede commit 286246a
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 30 deletions.
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ limitations under the License.
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ For documentation edits, include:

## Question or Problem

Sign up or log in: **Deep Sparse Community** [Discourse Forum](https://https://discuss.neuralmagic.com/) and/or [Slack](https://join.slack.com/t/discuss-neuralmagic/shared_invite/zt-q1a1cnvo-YBoICSIw3L1dmQpjBeDurQ). We are growing the community member by member and happy to see you there. Post all other questions including support or how to contribute. Don’t forget to search through existing discussions to avoid duplication! Thanks!
Sign up or log in to our [**Deep Sparse Community Slack**](https://join.slack.com/t/discuss-neuralmagic/shared_invite/zt-q1a1cnvo-YBoICSIw3L1dmQpjBeDurQ). We are growing the community member by member and happy to see you there. Post all other questions including support or how to contribute. Don’t forget to search through existing discussions to avoid duplication! Thanks!

## Developing SparseZoo

Expand Down
27 changes: 13 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ limitations under the License.
<img alt="GitHub" src="https://img.shields.io/github/license/neuralmagic/sparsezoo.svg?color=lightgray&style=for-the-badge" height=25>
</a>
<a href="https://github.com/neuralmagic/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>
<img alt="Contributor Covenant" src="https://img.shields.io/badge/Contributor%20Covenant-v2.1%20adopted-ff69b4.svg?color=yellow&style=for-the-badge" height=25>
</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>
Expand All @@ -55,19 +55,19 @@ limitations under the License.

[SparseZoo is a constantly-growing repository](https://sparsezoo.neuralmagic.com) of sparsified (pruned and pruned-quantized) models with matching sparsification recipes for neural networks.
It simplifies and accelerates your time-to-value in building performant deep learning models with a collection of inference-optimized models and recipes to prototype from.
Read more about sparsification [here](https://docs.neuralmagic.com/main/source/getstarted.html#sparsification).
Read more about sparsification [here.](https://docs.neuralmagic.com/main/source/getstarted.html#sparsification)

Available via API and hosted in the cloud, the SparseZoo contains both baseline and models sparsified to different degrees of inference performance vs. baseline loss recovery.
Recipe-driven approaches built around sparsification algorithms allow you to take the models as given, transfer-learn from the models onto private datasets, or transfer the recipes to your architectures.
Recipe-driven approaches built around sparsification algorithms allow you to use the models as given, transfer-learn from the models onto private datasets, or transfer the recipes to your architectures.

The [GitHub repository](https://github.com/neuralmagic/sparsezoo) contains the Python API code to handle the connection and authentication to the cloud.

<img alt="SparseZoo Flow" src="https://docs.neuralmagic.com/docs/source/infographics/sparsezoo.png" width="960px" />

## Highlights

- [Model Stub Architecture Overview](https://github.com/neuralmagic/sparsezoo/blob/main/docs/source/models.md)
- [Available Model Recipes](https://github.com/neuralmagic/sparsezoo/blob/main/docs/source/recipes.md)
- [Model Stub Architecture Overview](https://docs.neuralmagic.com/sparsezoo/source/models.html)
- [Available Model Recipes](https://docs.neuralmagic.com/sparsezoo/source/recipes.html)
- [sparsezoo.neuralmagic.com](https://sparsezoo.neuralmagic.com)

## Installation
Expand All @@ -83,7 +83,7 @@ pip install sparsezoo

## Quick Tour

### Python APIS
### Python APIs

The Python APIs respect this format enabling you to search and download models. Some code examples are given below.

Expand Down Expand Up @@ -165,14 +165,14 @@ sparsezoo search --domain cv --sub-domain classification \
--architecture resnet_v1 --sub-architecture 50
```

For a more in-depth read, check out [SparseZoo documentation](https://docs.neuralmagic.com/sparsezoo/).
For a more in-depth read, check out [SparseZoo documentation.](https://docs.neuralmagic.com/sparsezoo/)

## Resources

### Learning More

- Documentation: [SparseML](https://docs.neuralmagic.com/sparseml/), [SparseZoo](https://docs.neuralmagic.com/sparsezoo/), [Sparsify](https://docs.neuralmagic.com/sparsify/), [DeepSparse](https://docs.neuralmagic.com/deepsparse/)
- Neural Magic: [Blog](https://www.neuralmagic.com/blog/), [Resources](https://www.neuralmagic.com/resources/)
- Documentation: [SparseML,](https://docs.neuralmagic.com/sparseml/) [SparseZoo,](https://docs.neuralmagic.com/sparsezoo/) [Sparsify,](https://docs.neuralmagic.com/sparsify/) [DeepSparse](https://docs.neuralmagic.com/deepsparse/)
- Neural Magic: [Blog,](https://www.neuralmagic.com/blog/) [Resources](https://www.neuralmagic.com/resources/)

### Release History

Expand All @@ -185,19 +185,18 @@ Additionally, more information can be found via [GitHub Releases.](https://githu

### License

The project is licensed under the [Apache License Version 2.0](https://github.com/neuralmagic/sparsezoo/blob/main/LICENSE).
The project is licensed under the [Apache License Version 2.0.](https://github.com/neuralmagic/sparsezoo/blob/main/LICENSE)

## Community

### Contribute

We appreciate contributions to the code, examples, integrations, 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, integrations, and documentation as well as bug reports and feature requests! [Learn how here.](https://github.com/neuralmagic/sparsezoo/blob/main/CONTRIBUTING.md)

### Join

For user help or questions about SparseZoo, sign up or log in: **Deep Sparse Community** [Discourse Forum](https://discuss.neuralmagic.com/) and/or [Slack](https://join.slack.com/t/discuss-neuralmagic/shared_invite/zt-q1a1cnvo-YBoICSIw3L1dmQpjBeDurQ).
We are growing the community member by member and happy to see you there.
For user help or questions about SparseZoo, sign up or log in to our [**Deep Sparse Community Slack**](https://join.slack.com/t/discuss-neuralmagic/shared_invite/zt-q1a1cnvo-YBoICSIw3L1dmQpjBeDurQ). We are growing the community member by member and happy to see you there. Bugs, feature requests, or additional questions can also be posted to our [GitHub Issue Queue.](https://github.com/neuralmagic/sparsezoo/issues)

You can get the latest news, webinar and event invites, research papers, and other ML Performance tidbits by [subscribing](https://neuralmagic.com/subscribe/) to the Neural Magic community.

For more general questions about Neural Magic, please fill out this [form](http://neuralmagic.com/contact/).
For more general questions about Neural Magic, please fill out this [form.](http://neuralmagic.com/contact/)
3 changes: 1 addition & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
:maxdepth: 3
:caption: General

SparseZoo Repository <https://github.com/neuralmagic/sparsezoo/issues>
SparseZoo Repository <https://sparsezoo.neuralmagic.com>
source/models
source/recipes

Expand All @@ -34,7 +34,6 @@
:caption: Connect Online

Bugs, Feature Requests <https://github.com/neuralmagic/sparsezoo/issues>
Support, General Q&A Forums <https://discuss.neuralmagic.com/>
Deep Sparse Community Slack <https://join.slack.com/t/discuss-neuralmagic/shared_invite/zt-q1a1cnvo-YBoICSIw3L1dmQpjBeDurQ>
Neural Magic GitHub <https://github.com/neuralmagic>
Neural Magic Docs <https://docs.neuralmagic.com>
Expand Down
24 changes: 12 additions & 12 deletions docs/source/models.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,18 +38,18 @@ The properties within each model stub are defined as the following:

The contents of each model are made up of the following:

- model.md: The model card containing metadata, descriptions, and information for the model.
- model.onnx: The [ONNX](https://onnx.ai/) representation of the model's graph.
- model.onnx.tar.gz: A compressed format for the ONNX file.
Currently ONNX does not support sparse tensors and quantized sparse tensors well for compression.
- [FRAMEWORK]/model.[EXTENSION]: The native ML framework file(s) for the model in which it was originally trained.
- `model.md`: The model card containing metadata, descriptions, and information for the model.
- `model.onnx`: The [ONNX](https://onnx.ai/) representation of the model's graph.
- `model.onnx.tar.gz`: A compressed format for the ONNX file.
Currently, ONNX does not support sparse tensors and quantized sparse tensors well for compression.
- `[FRAMEWORK]/model.[EXTENSION]`: The native ML framework file(s) for the model in which it was originally trained.
Such as PyTorch, Keras, TensorFlow V1
- recipes/original.[md|yaml]: The original sparsification recipe used to create the model.
- recipes/[NAME].[md|yaml]: Additional sparsification recipes that can be used with the model such as transfer learning.
- sample-originals: The original sample data without any preprocessing for use with the model.
- sample-inputs: The sample data after pre processing for use with the model.
- sample-outputs: The outputs after running the sample inputs through the model.
- sample-labels: The labels that classify the sample inputs.
- `recipes/original.[md|yaml]`: The original sparsification recipe used to create the model.
- `recipes/[NAME].[md|yaml]`: Additional sparsification recipes that can be used with the model such as transfer learning.
- `sample-originals`: The original sample data without any pre-processing for use with the model.
- `sample-inputs`: The sample data after pre-processing for use with the model.
- `sample-outputs`: The outputs after running the sample inputs through the model.
- `sample-labels`: The labels that classify the sample inputs.

### Image Classification

Expand All @@ -65,4 +65,4 @@ Image classification table not loading? View full table [here](https://sparsezoo
<iframe src="https://sparsezoo.neuralmagic.com/tables/models/cv/detection" title="Object Detect Models" width="100%" height="500px"></iframe>
</div>

Object detection table not loading? View full table [here](https://sparsezoo.neuralmagic.com/tables/models/cv/detection).
Object detection table not loading? View full table [here](https://sparsezoo.neuralmagic.com/tables/models/cv/detection).

0 comments on commit 286246a

Please sign in to comment.