Neural Magic LogoNeural Magic Logo
Products
menu-icon
Products
DeepSparse EngineSparseMLSparseZoo
Products
DeepSparse
Community Edition

tool icon   DeepSparse Community Edition

Sparsity-aware neural network inference engine for GPU-class performance on CPUs

A CPU runtime that takes advantage of sparsity within neural networks to reduce compute. Read more about sparsification Read more about sparsification here.

Neural Magic's DeepSparse Engine is able to integrate into popular deep learning libraries (e.g., Hugging Face, Ultralytics) allowing you to leverage DeepSparse for loading and deploying sparse models with ONNX. ONNX gives the flexibility to serve your model in a framework-agnostic environment. Support includes PyTorch, TensorFlow, Keras, and many other frameworks.

The DeepSparse Engine is available in two editions:

  1. The Community Edition is open-source and free for evaluation, research, and non-production use with our Engine Community License.
  2. The Enterprise Edition requires a Trial License or can be fully licensed for production, commercial applications.

Features

🧰 Hardware Support and System Requirements

Review CPU Hardware Support for Various Architectures to understand system requirements. The DeepSparse Engine works natively on Linux; Mac and Windows require running Linux in a Docker or virtual machine; it will not run natively on those operating systems.

The DeepSparse Engine is tested on Python 3.7-3.10, ONNX 1.5.0-1.12.0, ONNX opset version 11+, and manylinux compliant. Using a virtual environment is highly recommended.

Installation

Install the DeepSparse Community Edition as follows:

pip install deepsparse

See the DeepSparse Community Installation Page for further installation options.

To trial or inquire about licensing for DeepSparse Enterprise Edition, see the DeepSparse Enterprise documentation.

Features

🔌 DeepSparse Server

The DeepSparse Server allows you to serve models and pipelines from the terminal. The server runs on top of the popular FastAPI web framework and Uvicorn web server. Install the server using the following command:

pip install deepsparse[server]

Single Model

Once installed, the following example CLI command is available for running inference with a single BERT model:

1deepsparse.server \
2 task question_answering \
3 --model_path "zoo:nlp/question_answering/bert-base/pytorch/huggingface/squad/12layer_pruned80_quant-none-vnni"

To look up arguments run: deepsparse.server --help.

Multiple Models

To serve multiple models in your deployment you can easily build a config.yaml. In the example below, we define two BERT models in our configuration for the question answering task:

1num_cores: 1
2num_workers: 1
3endpoints:
4 - task: question_answering
5 route: /predict/question_answering/base
6 model: zoo:nlp/question_answering/bert-base/pytorch/huggingface/squad/base-none
7 batch_size: 1
8 - task: question_answering
9 route: /predict/question_answering/pruned_quant
10 model: zoo:nlp/question_answering/bert-base/pytorch/huggingface/squad/12layer_pruned80_quant-none-vnni
11 batch_size: 1

Finally, after your config.yaml file is built, run the server with the config file path as an argument:

deepsparse.server config config.yaml

Getting Started with the DeepSparse Server for more info.

📜 DeepSparse Benchmark

The benchmark tool is available on your CLI to run expressive model benchmarks on the DeepSparse Engine with minimal parameters.

Run deepsparse.benchmark -h to look up arguments:

1deepsparse.benchmark [-h] [-b BATCH_SIZE] [-shapes INPUT_SHAPES]
2 [-ncores NUM_CORES] [-s {async,sync}] [-t TIME]
3 [-nstreams NUM_STREAMS] [-pin {none,core,numa}]
4 [-q] [-x EXPORT_PATH]
5 model_path

Getting Started with CLI Benchmarking includes examples of select inference scenarios:

  • Synchronous (Single-stream) Scenario
  • Asynchronous (Multi-stream) Scenario

👩‍💻 NLP Inference Example

1from deepsparse import Pipeline
2
3# SparseZoo model stub or path to ONNX file
4model_path = "zoo:nlp/question_answering/bert-base/pytorch/huggingface/squad/12layer_pruned80_quant-none-vnni"
5
6qa_pipeline = Pipeline.create(
7 task="question-answering",
8 model_path=model_path,
9)
10
11my_name = qa_pipeline(question="What's my name?", context="My name is Snorlax")

NLP Tutorials:

Tasks Supported:

🦉 SparseZoo ONNX vs. Custom ONNX Models

DeepSparse can accept ONNX models from two sources:

  • SparseZoo ONNX: our open-source collection of sparse models available for download. SparseZoo hosts inference-optimized models, trained on repeatable sparsification recipes using state-of-the-art techniques from SparseML.

  • Custom ONNX: your own ONNX model, can be dense or sparse. Plug in your model to compare performance with other solutions.

>wget https://github.com/onnx/models/raw/main/vision/classification/mobilenet/model/mobilenetv2-7.onnx
1Saving to: ‘mobilenetv2-7.onnx’

Custom ONNX Benchmark example:

1from deepsparse import compile_model
2from deepsparse.utils import generate_random_inputs
3onnx_filepath = "mobilenetv2-7.onnx"
4batch_size = 16
5
6# Generate random sample input
7inputs = generate_random_inputs(onnx_filepath, batch_size)
8
9# Compile and run
10engine = compile_model(onnx_filepath, batch_size)
11outputs = engine.run(inputs)

The GitHub repository includes package APIs along with examples to quickly get started benchmarking and inferencing sparse models.

Scheduling Single-Stream, Multi-Stream, and Elastic Inference

The DeepSparse Engine offers up to three types of inferences based on your use case. Read more details here: Inference Types.

1 ⚡ Single-stream scheduling: the latency/synchronous scenario, requests execute serially. [default]

single stream diagram

Use Case: It's highly optimized for minimum per-request latency, using all of the system's resources provided to it on every request it gets.

2 ⚡ Multi-stream scheduling: the throughput/asynchronous scenario, requests execute in parallel.

multi stream diagram

PRO TIP: The most common use cases for the multi-stream scheduler are where parallelism is low with respect to core count, and where requests need to be made asynchronously without time to batch them.

3 ⚡ Elastic scheduling: requests execute in parallel, but not multiplexed on individual NUMA nodes.

Use Case: A workload that might benefit from the elastic scheduler is one in which multiple requests need to be handled simultaneously, but where performance is hindered when those requests have to share an L3 cache.

Resources

Libraries

Versions

Info

Community

Be Part of the Future... And the Future is Sparse!

Contribute with code, examples, integrations, and documentation as well as bug reports and feature requests! Learn how here.

For user help or questions about DeepSparse, sign up or log in to our Deep Sparse Community Slack. 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. You can get the latest news, webinar and event invites, research papers, and other ML Performance tidbits by subscribing to the Neural Magic community.

For more general questions about Neural Magic, complete this form.

License

The Community Edition of the project's binary containing the DeepSparse Engine is licensed under the Neural Magic Engine License. Example files and scripts included in this repository are licensed under the Apache License Version 2.0 as noted.

The Enterprise Edition requires a Trial License or can be fully licensed for production, commercial applications.

Cite

Find this project useful in your research or other communications? Please consider citing:

1@InProceedings{
2 pmlr-v119-kurtz20a,
3 title = {Inducing and Exploiting Activation Sparsity for Fast Inference on Deep Neural Networks},
4 author = {Kurtz, Mark and Kopinsky, Justin and Gelashvili, Rati and Matveev, Alexander and Carr, John and Goin, Michael and Leiserson, William and Moore, Sage and Nell, Bill and Shavit, Nir and Alistarh, Dan},
5 booktitle = {Proceedings of the 37th International Conference on Machine Learning},
6 pages = {5533--5543},
7 year = {2020},
8 editor = {Hal Daumé III and Aarti Singh},
9 volume = {119},
10 series = {Proceedings of Machine Learning Research},
11 address = {Virtual},
12 month = {13--18 Jul},
13 publisher = {PMLR},
14 pdf = {http://proceedings.mlr.press/v119/kurtz20a/kurtz20a.pdf},
15 url = {http://proceedings.mlr.press/v119/kurtz20a.html}
16}
17
18@article{DBLP:journals/corr/abs-2111-13445,
19 author = {Eugenia Iofinova and
20 Alexandra Peste and
21 Mark Kurtz and
22 Dan Alistarh},
23 title = {How Well Do Sparse Imagenet Models Transfer?},
24 journal = {CoRR},
25 volume = {abs/2111.13445},
26 year = {2021},
27 url = {https://arxiv.org/abs/2111.13445},
28 eprinttype = {arXiv},
29 eprint = {2111.13445},
30 timestamp = {Wed, 01 Dec 2021 15:16:43 +0100},
31 biburl = {https://dblp.org/rec/journals/corr/abs-2111-13445.bib},
32 bibsource = {dblp computer science bibliography, https://dblp.org}
33}
DeepSparse
DeepSparse CLI