Skip to content

Commit 02482c2

Browse files
markurtzjeanniefinksrobertgshaw2-redhat
authored
Update docs for DeepSparse Enterprise (#101)
* Update docs for DeepSparse Enterprise * Remove old files, update path location for deepsparse enterprise * Update deepsparse and sparsezoo to reflect 3.10 python support * Update install.mdx Grammar * Update src/content/get-started/install/deepsparse.mdx Co-authored-by: Jeannie Finks <[email protected]> * Update src/content/get-started/install/deepsparse.mdx Co-authored-by: Jeannie Finks <[email protected]> * update deepsparse license messaging * Update install.mdx should have no spaces between pip install sparseml[torch,torchvision] Co-authored-by: Jeannie Finks <[email protected]> Co-authored-by: rsnm2 <[email protected]>
1 parent 998402a commit 02482c2

File tree

16 files changed

+516
-187
lines changed

16 files changed

+516
-187
lines changed

src/content/get-started/install.mdx

+8-4
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,26 @@ index: 0
99
# Installation
1010

1111
The Deep Sparse Platform is made up of core libraries that are available as Python APIs and CLIs.
12-
All Python APIs and CLIs are installable through pip utilizing [PyPi](https://pypi.org/user/neuralmagic/).
12+
All Python APIs and CLIs are installed through pip utilizing [PyPI](https://pypi.org/user/neuralmagic/).
1313
It is recommended to install in a [virtual environment](https://docs.python.org/3/library/venv.html) to encapsulate your local environment.
1414

1515
## Quick Start
1616

1717
To begin using the Deep Sparse Platform, run the following commands which install standard setups for deployment with [DeepSparse](../../products/deepsparse) and model training/optimization with [SparseML](../../products/sparseml):
1818

1919
```bash
20-
pip install deepsparse[server] sparseml[torch, torchvision]
20+
pip install deepsparse[server] sparseml[torch,torchvision]
2121
```
2222

23-
## Installable Packages
23+
## Package Installations
2424

2525
<LinkCards>
2626
<LinkCard href="./deepsparse" heading="DeepSparse">
27-
Install DeepSparse for performant inference on CPUs.
27+
Install the DeepSparse Community Edition for performant inference on CPUs.
28+
</LinkCard>
29+
30+
<LinkCard href="./deepsparse-ent" heading="DeepSparse Enterprise">
31+
Install the DeepSparse Enterprise Edition for performant inference on CPUs in production deployments.
2832
</LinkCard>
2933

3034
<LinkCard href="./sparseml" heading="SparseML">
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: "DeepSparse Enterprise"
3+
metaTitle: "DeepSparse Enterprise Installation"
4+
metaDescription: "Installation instructions for the DeepSparse Engine enabling performant neural network deployments"
5+
githubURL: "https://github.com/neuralmagic/docs/blob/main/src/content/install/deepsparse.mdx"
6+
index: 2000
7+
---
8+
9+
# DeepSparse Enterprise Edition Installation
10+
11+
The [DeepSparse Engine](/products/deepsparse-ent) enables GPU-class performance on CPUs, leveraging sparsity within models to reduce FLOPs and the unique cache hierarchy on CPUs to reduce memory movement.
12+
The engine accepts models in the open-source [ONNX format](https://onnx.ai/), which are easily created from PyTorch and TensorFlow models.
13+
14+
Currently, DeepSparse is tested on Python 3.7-3.10, ONNX 1.5.0-1.10.1, ONNX opset version 11+ and is [manylinux compliant](https://peps.python.org/pep-0513/).
15+
It is limited to Linux systems running on x86 CPU architectures.
16+
17+
The DeepSparse Engine is available in two editions:
18+
1. [**The Community Edition**](/products/deepsparse) is open-source and free for evaluation, research, and non-production use with our [Engine Community License](https://neuralmagic.com/legal/engine-license-agreement/).
19+
2. [**The Enterprise Edition**](/products/deepsparse-ent) requires a Trial License or [can be fully licensed](https://neuralmagic.com/legal/master-software-license-and-service-agreement/) for production, commercial applications.
20+
21+
## General Install
22+
23+
Use the following command to install with pip:
24+
25+
```bash
26+
pip install deepsparse-ent
27+
```
28+
29+
## Server Install
30+
31+
The [DeepSparse Server](/use-cases/deploying-deepsparse/deepsparse-server) allows you to serve models and pipelines through an HTTP interface using the deepsparse.server CLI.
32+
To install, use the following extra option:
33+
34+
```bash
35+
pip install deepsparse-ent[server]
36+
```
37+
38+
## YOLO Install
39+
40+
The [Ultralytics YOLOv5](/use-cases/object-detection/deploying) models require extra dependencies for deployment.
41+
To use YOLO models, install with the following extra option:
42+
43+
```bash
44+
pip install deepsparse-ent[yolo] # just yolo requirements
45+
pip install deepsparse-ent[yolo,server] # both yolo + server requirements
46+
```

src/content/get-started/install/deepsparse.mdx

+8-4
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,21 @@ githubURL: "https://github.com/neuralmagic/docs/blob/main/src/content/install/de
66
index: 1000
77
---
88

9-
# DeepSparse Installation
9+
# DeepSparse Community Edition Installation
1010

1111
The [DeepSparse Engine](/products/deepsparse) enables GPU-class performance on CPUs, leveraging sparsity within models to reduce FLOPs and the unique cache hierarchy on CPUs to reduce memory movement.
1212
The engine accepts models in the open-source [ONNX format](https://onnx.ai/), which are easily created from PyTorch and TensorFlow models.
1313

14-
Currently, DeepSparse is tested on Python 3.7-3.9, ONNX 1.5.0-1.10.1, ONNX opset version 11+ and is [manylinux compliant](https://peps.python.org/pep-0513/).
14+
Currently, DeepSparse is tested on Python 3.7-3.10, ONNX 1.5.0-1.10.1, ONNX opset version 11+ and is [manylinux compliant](https://peps.python.org/pep-0513/).
1515
It is limited to Linux systems running on x86 CPU architectures.
1616

17-
## General Install
17+
The DeepSparse Engine is available in two editions:
18+
1. [**The Community Edition**](/products/deepsparse) is open-source and free for evaluation, research, and non-production use with our [Engine Community License](https://neuralmagic.com/legal/engine-license-agreement/).
19+
2. [**The Enterprise Edition**](/products/deepsparse-ent) requires a Trial License or [can be fully licensed](https://neuralmagic.com/legal/master-software-license-and-service-agreement/) for production, commercial applications.
1820

19-
Use the following command to install with pip:
21+
## General Installation
22+
23+
Use the following command to install the Community Edition with pip:
2024

2125
```bash
2226
pip install deepsparse

src/content/get-started/install/sparseml.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "SparseML"
33
metaTitle: "SparseML Installation"
44
metaDescription: "Installation instructions for SparseML neural network optimization, training, and sparsification"
55
githubURL: "https://github.com/neuralmagic/docs/blob/main/src/content/install/sparseml.mdx"
6-
index: 2000
6+
index: 3000
77
---
88

99
# SparseML Installation

src/content/get-started/install/sparsezoo.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "SparseZoo"
33
metaTitle: "SparseZoo Installation"
44
metaDescription: "Installation instructions for the SparseZoo sparse model repository"
55
githubURL: "https://github.com/neuralmagic/docs/blob/main/src/content/install/sparsezoo.mdx"
6-
index: 3000
6+
index: 4000
77
---
88

99
# SparseZoo Installation
@@ -13,7 +13,7 @@ This installs the Python API and CLIs for downloading models and recipes from th
1313

1414
Note that the SparseZoo package is automatically installed with both SparseML and DeepSparse.
1515

16-
Currently, the SparseZoo Python APIs and CLIs are tested on Python 3.7-3.9 and are limited to [Linux](https://www.linux.org/) and [MacOS](https://www.apple.com/mac/) systems.
16+
Currently, the SparseZoo Python APIs and CLIs are tested on Python 3.7-3.10 and are limited to [Linux](https://www.linux.org/) and [MacOS](https://www.apple.com/mac/) systems.
1717

1818
## General Install
1919

0 commit comments

Comments
 (0)