|
| 1 | +--- |
| 2 | +title: "DeepSparse Enterprise" |
| 3 | +metaTitle: "DeepSparse Enterprise" |
| 4 | +metaDescription: "Deepsparse Enterprise" |
| 5 | +githubURL: "https://github.com/neuralmagic/docs/blob/main/src/content/user-guide/deepsparse-engine/deepsparse-enterprise.mdx" |
| 6 | +index: 6000 |
| 7 | +--- |
| 8 | + |
| 9 | +# DeepSparse Enterprise Edition |
| 10 | + |
| 11 | +The DeepSparse Engine is available in two editions: |
| 12 | +1. **The Community Edition** is open-source and free for evaluation, research, and non-production use with our [Engine Community License](https://neuralmagic.com/legal/engine-license-agreement/). |
| 13 | +2. **The Enterprise Edition** requires a Trial License or [can be fully licensed](https://neuralmagic.com/legal/master-software-license-and-service-agreement/) for production, commercial applications. |
| 14 | + |
| 15 | +## Installation |
| 16 | +Install the Enterprise Edition as follows: |
| 17 | + |
| 18 | +```bash |
| 19 | +pip install deepsparse-ent |
| 20 | +``` |
| 21 | + |
| 22 | +### Getting a License |
| 23 | +The DeepSparse Enterprise Edition requires a valid license to run the engine and can be licensed for production, commercial applications. There are two options available: |
| 24 | + |
| 25 | +#### 90-Day Enterprise Trial License |
| 26 | +To try out the DeepSparse Enterprise Edition and get a Neural Magic Trial License, complete our [registration form](https://neuralmagic.com/deepsparse-engine-free-trial). Upon submission, the license will be emailed to you and your 90-day term starts right then. |
| 27 | + |
| 28 | +#### Enterprise Edition License |
| 29 | +To learn more about DeepSparse Enterprise Edition pricing, [contact our Sales team](https://neuralmagic.com/deepsparse-engine/#form) to discuss your use case further for a custom quote. |
| 30 | + |
| 31 | +### Installing a License |
| 32 | +<details> |
| 33 | + <summary>Installing a License</summary> |
| 34 | + |
| 35 | +Once you have obtained a license, you will need to initialize it to be able to run the DeepSparse Enterprise Edition. You can initialize your license by running the command: |
| 36 | + |
| 37 | +```bash |
| 38 | +deepsparse.license |
| 39 | +``` |
| 40 | + |
| 41 | +`deepsparse.license` takes one argument that is a reference to the license and can be referenced in the `deepsparse.license` command as either `<license_string>` or `path/to/license.txt`. |
| 42 | + |
| 43 | +To initialize a license on a machine: |
| 44 | +1. Confirm you have deepsparse-ent installed in a fresh virtual environment. |
| 45 | + - Note: Installing deepsparse and deepsparse-ent on the same virtual environment may result in unsupported behaviors. |
| 46 | +2. Run `deepsparse.license` with the `<license_string>` or `path/to/license.txt` as an argument as follows: |
| 47 | + - `deepsparse.license <samplelicensetring>` |
| 48 | + - `deepsparse.license ./license.txt` |
| 49 | +3. If successful, `deepsparse.license` will write the license file to `~/.config/neuralmagic/license.txt`. You may overwrite this path by setting the environment variable `NM_CONFIG_DIR` (before and after running the script) with the following command: |
| 50 | + - `export NM_CONFIG_DIR=path/to/license.txt` |
| 51 | + |
| 52 | +4. Once the license is authenticated, you should see a splash message indicating that you are now running DeepSparse Enterprise Edition. |
| 53 | + |
| 54 | +If you encounter issues initializing your DeepSparse Enterprise Edition License, contact [[email protected]](mailto:[email protected]) for help. |
| 55 | + |
| 56 | +</details> |
| 57 | + |
| 58 | +### Validating a License |
| 59 | +<details> |
| 60 | + <summary>Validating a License</summary> |
| 61 | + |
| 62 | +Once you have initialized your license, you may want to check if it is still valid before running a workload on DeepSparse Enterprise Edition. To confirm your license is still active with the DeepSparse Enterprise Edition, run the command: |
| 63 | + |
| 64 | +```bash |
| 65 | +deepsparse.validate_license |
| 66 | +``` |
| 67 | + |
| 68 | +`deepsparse.validate_license` can be run with no arguments, which will reference an existing environment variable (if set), or with one argument that is a reference to the license and can be referenced in the `deepsparse.validate_license` command as `path/to/license.txt`. |
| 69 | + |
| 70 | +To validate a license on a machine: |
| 71 | +1. If you have successfully ran `deepsparse.license`, `deepsparse.validate_license` can be used to validate that the license file is in the correct location: |
| 72 | + - Run the `deepsparse.validate_license` with no arguments. If the referenced license is valid, you should get the DeepSparse Enterprise Edition splash screen printed out in your terminal window. |
| 73 | + - If the `NM_CONFIG_DIR` environment variable was set when creating the license, ensure this variable is still set to the same value. |
| 74 | +2. If you want to supply the `path/to/license.txt`: |
| 75 | + - Run the `deepsparse.validate_license` with `path/to/license.txt` as an argument as follows: |
| 76 | + - `deepsparse.validate_license --license_path path/to/license.txt` |
| 77 | + - If the referenced license is valid, you should get the DeepSparse Enterprise Edition splash screen printed out in your terminal window. |
| 78 | + |
| 79 | +If you encounter issues validating your DeepSparse Enterprise Edition License, contact [[email protected]](mailto:[email protected]) for help. |
| 80 | + |
| 81 | +</details> |
0 commit comments