Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Cherry-pick] Docs fixes #1045

Merged
merged 4 commits into from
May 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/deepsparse/image_classification/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ your machine is compatible with our [hardware requirements].

### Installation

```pip install deepsparse```
```pip install deepsparse[image_classification]```

### Model Format

Expand Down Expand Up @@ -122,7 +122,7 @@ pip install deepsparse[server]
The following section includes example usage of the Pipeline and server APIs for
various image classification models.

[List of Image Classification SparseZoo Models](https://sparsezoo.neuralmagic.com/?domain=cv&sub_domain=classification&page=1)
[List of Image Classification SparseZoo Models](https://sparsezoo.neuralmagic.com/?useCase=classification)


#### Python Pipeline
Expand Down Expand Up @@ -196,4 +196,4 @@ For Neural Magic Support, sign up or log in to our [Deep Sparse Community Slack]
[ONNX]: https://onnx.ai/
[SparseML]: https://github.com/neuralmagic/sparseml
[SparseML Image Classification Documentation]: https://github.com/neuralmagic/sparseml/tree/main/src/sparseml/pytorch/image_classification/README_image_classification.md
[SparseZoo]: https://sparsezoo.neuralmagic.com/
[SparseZoo]: https://sparsezoo.neuralmagic.com/
8 changes: 4 additions & 4 deletions src/deepsparse/transformers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ for the `question` as a substring of the `context`. The following examples use
question answering BERT model trained on the `SQuAD` dataset downloaded by default from the SparseZoo.

[List of available SparseZoo Question Answering Models](
https://sparsezoo.neuralmagic.com/?page=1&domain=nlp&sub_domain=question_answering)
https://sparsezoo.neuralmagic.com/?useCase=question_answering)

#### Python Pipeline

Expand Down Expand Up @@ -144,7 +144,7 @@ uses a pruned and quantized text sentiment analysis BERT model trained on the `s
from the SparseZoo. This `sst2` model classifies sentences as positive or negative.

[List of available SparseZoo Sentiment Analysis Models](
https://sparsezoo.neuralmagic.com/?domain=nlp&sub_domain=sentiment_analysis)
https://sparsezoo.neuralmagic.com/?useCase=sentiment_analysis)

#### Python Pipeline
```python
Expand Down Expand Up @@ -190,7 +190,7 @@ DistilBERT model trained on the `qqp` dataset downloaded from a SparseZoo stub.
The `qqp` dataset takes pairs of questions and predicts if they are a duplicate or not.

[List of available SparseZoo Text Classification Models](
https://sparsezoo.neuralmagic.com/?page=1&domain=nlp&sub_domain=text_classification)
https://sparsezoo.neuralmagic.com/?useCase=text_classification)

#### Python Pipeline
```python
Expand Down Expand Up @@ -249,7 +249,7 @@ The following example uses a pruned and quantized token classification NER BERT
trained on the `CoNLL` dataset downloaded from the SparseZoo.

[List of available SparseZoo Token Classification Models](
https://sparsezoo.neuralmagic.com/?page=1&domain=nlp&sub_domain=token_classification)
https://sparsezoo.neuralmagic.com/?useCase=token_classification)

#### Python Pipeline
```python
Expand Down
4 changes: 2 additions & 2 deletions src/deepsparse/yolo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ sparseml.yolov5.export_onnx \
--weights path/to/your/model \
--dynamic #Allows for dynamic input shape
```
This creates `model.onnx` file, in the directory of your `weights` (e.g. `runs/train/weights/model.onnx`).
This creates a DeepSparse_Deployment folder with a `model.onnx` file (e.g. `runs/train/exp/DeepSparse_Deployment/model.onnx`).

#### SparseZoo Stub
Alternatively, you can skip the process of the ONNX model export by using Neural Magic's [SparseZoo](https://sparsezoo.neuralmagic.com/). The SparseZoo contains pre-sparsified models and SparseZoo stubs enable you to reference any model on the SparseZoo in a convenient and predictable way.
Expand Down Expand Up @@ -76,7 +76,7 @@ pip install deepsparse[yolo,server]
The following example uses pipelines to run a pruned and quantized YOLOv5l model for inference, downloaded by default from the SparseZoo. As input the pipeline ingests a list of images and returns for each image the detection boxes in numeric form.

[List of the YOLOv5 SparseZoo Models](
https://sparsezoo.neuralmagic.com/?domain=cv&sub_domain=detection&page=1)
https://sparsezoo.neuralmagic.com/?useCase=detection&architectures=yolov5)

If you don't have an image ready, pull a sample image down with

Expand Down