Skip to content

Commit 286246a

Browse files
authored
Update README.md, index.rst, CONTRIB, CONDUCT (#131)
* 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
1 parent 15e7ede commit 286246a

File tree

5 files changed

+28
-30
lines changed

5 files changed

+28
-30
lines changed

CODE_OF_CONDUCT.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ limitations under the License.
2121
In the interest of fostering an open and welcoming environment, we as
2222
contributors and maintainers pledge to making participation in our project and
2323
our community a harassment-free experience for everyone, regardless of age, body
24-
size, disability, ethnicity, sex characteristics, gender identity and expression,
24+
size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression,
2525
level of experience, education, socio-economic status, nationality, personal
2626
appearance, race, religion, or sexual identity and orientation.
2727

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ For documentation edits, include:
7777

7878
## Question or Problem
7979

80-
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!
80+
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!
8181

8282
## Developing SparseZoo
8383

README.md

+13-14
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ limitations under the License.
3838
<img alt="GitHub" src="https://img.shields.io/github/license/neuralmagic/sparsezoo.svg?color=lightgray&style=for-the-badge" height=25>
3939
</a>
4040
<a href="https://github.com/neuralmagic/sparsezoo/blob/main/CODE_OF_CONDUCT.md">
41-
<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>
41+
<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>
4242
</a>
4343
<a href="https://www.youtube.com/channel/UCo8dO_WMGYbWCRnj_Dxr4EA">
4444
<img src="https://img.shields.io/badge/-YouTube-red?&style=for-the-badge&logo=youtube&logoColor=white" height=25>
@@ -55,19 +55,19 @@ limitations under the License.
5555

5656
[SparseZoo is a constantly-growing repository](https://sparsezoo.neuralmagic.com) of sparsified (pruned and pruned-quantized) models with matching sparsification recipes for neural networks.
5757
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.
58-
Read more about sparsification [here](https://docs.neuralmagic.com/main/source/getstarted.html#sparsification).
58+
Read more about sparsification [here.](https://docs.neuralmagic.com/main/source/getstarted.html#sparsification)
5959

6060
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.
61-
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.
61+
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.
6262

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

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

6767
## Highlights
6868

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

7373
## Installation
@@ -83,7 +83,7 @@ pip install sparsezoo
8383

8484
## Quick Tour
8585

86-
### Python APIS
86+
### Python APIs
8787

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

@@ -165,14 +165,14 @@ sparsezoo search --domain cv --sub-domain classification \
165165
--architecture resnet_v1 --sub-architecture 50
166166
```
167167

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

170170
## Resources
171171

172172
### Learning More
173173

174-
- 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/)
175-
- Neural Magic: [Blog](https://www.neuralmagic.com/blog/), [Resources](https://www.neuralmagic.com/resources/)
174+
- 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/)
175+
- Neural Magic: [Blog,](https://www.neuralmagic.com/blog/) [Resources](https://www.neuralmagic.com/resources/)
176176

177177
### Release History
178178

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

186186
### License
187187

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

190190
## Community
191191

192192
### Contribute
193193

194-
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).
194+
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)
195195

196196
### Join
197197

198-
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).
199-
We are growing the community member by member and happy to see you there.
198+
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)
200199

201200
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.
202201

203-
For more general questions about Neural Magic, please fill out this [form](http://neuralmagic.com/contact/).
202+
For more general questions about Neural Magic, please fill out this [form.](http://neuralmagic.com/contact/)

docs/index.rst

+1-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
:maxdepth: 3
2020
:caption: General
2121

22-
SparseZoo Repository <https://github.com/neuralmagic/sparsezoo/issues>
22+
SparseZoo Repository <https://sparsezoo.neuralmagic.com>
2323
source/models
2424
source/recipes
2525

@@ -34,7 +34,6 @@
3434
:caption: Connect Online
3535

3636
Bugs, Feature Requests <https://github.com/neuralmagic/sparsezoo/issues>
37-
Support, General Q&A Forums <https://discuss.neuralmagic.com/>
3837
Deep Sparse Community Slack <https://join.slack.com/t/discuss-neuralmagic/shared_invite/zt-q1a1cnvo-YBoICSIw3L1dmQpjBeDurQ>
3938
Neural Magic GitHub <https://github.com/neuralmagic>
4039
Neural Magic Docs <https://docs.neuralmagic.com>

docs/source/models.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -38,18 +38,18 @@ The properties within each model stub are defined as the following:
3838

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

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

5454
### Image Classification
5555

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

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

0 commit comments

Comments
 (0)