https://github.com/neuralmagic/docs
Top-level directory for documentation and general content
https://github.com/neuralmagic/docs
Last synced: about 1 year ago
JSON representation
Top-level directory for documentation and general content
- Host: GitHub
- URL: https://github.com/neuralmagic/docs
- Owner: neuralmagic
- Created: 2021-01-12T00:00:04.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-11-25T22:20:55.000Z (over 1 year ago)
- Last Synced: 2025-03-29T06:05:52.861Z (about 1 year ago)
- Language: MDX
- Homepage: http://docs.neuralmagic.com/
- Size: 750 MB
- Stars: 120
- Watchers: 22
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Neural Magic Documentation
The Neural Magic Platform provides a suite of software components to select, build, and run performant
deep learning models on CPU resources.
[Our Documentation website](https://docs.neuralmagic.com/) is a great starting point. To learn more about specific Neural Magic products, review the links below.
To file a documentation issue for a specific software component, use its repo issue tracker.
| Docs | GitHub | Issue Tracker | Releases | License |
| ------------------------------------------------------------- | -------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | ------------------- |
| [SparseML](https://docs.neuralmagic.com/products/sparseml/) | [Repo](https://github.com/neuralmagic/sparseml/) | [Queue](https://github.com/neuralmagic/sparseml/issues/) | [Index](https://github.com/neuralmagic/sparseml/releases/) | Apache 2.0 |
| [Sparsify](https://docs.neuralmagic.com/products/sparsify/) | [Repo](https://github.com/neuralmagic/sparsify/) | [Queue](https://github.com/neuralmagic/sparsify/issues/) | [Index](https://github.com/neuralmagic/sparsify/releases/) | Apache 2.0 |
| [SparseZoo](https://docs.neuralmagic.com/products/sparsezoo/) | [Repo](https://github.com/neuralmagic/sparsezoo/) | [Queue](https://github.com/neuralmagic/sparsezoo/issues/) | [Index](https://github.com/neuralmagic/sparsezoo/releases/) | Apache 2.0 |
| [DeepSparse Community](https://docs.neuralmagic.com/products/deepsparse/) | [Repo](https://github.com/neuralmagic/deepsparse/) | [Queue](https://github.com/neuralmagic/deepsparse/issues/) | [Index](https://github.com/neuralmagic/deepsparse/releases/) | [Neural Magic DeepSparse Community](https://neuralmagic.com/legal/deepsparse-license-agreement/) |
| [DeepSparse Enterprise](https://docs.neuralmagic.com/get-started/install/deepsparse#enterprise-installation) | - | [Queue](https://github.com/neuralmagic/deepsparse/issues/) | [Index](https://github.com/neuralmagic/deepsparse/releases/) | [MSLSA (Enterprise)](https://neuralmagic.com/legal/master-software-license-and-service-agreement/) |
For user help or questions, sign up or log in to our [**Neural Magic Community Slack**](https://neuralmagic.com/community/). 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 Queues](https://github.com/neuralmagic/) for the related repository.
To contribute to Neural Magic documentation, please:
Open a [GitHub issue](https://github.com/neuralmagic/docs/issues/) and give it
the `documentation` label.
Submit a [pull request](https://github.com/neuralmagic/docs/pulls/) with your
proposed documentation changes.
Get started with
[writing and formatting on GitHub.](https://help.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github)
To learn more about Neural Magic, [check our website.](https://www.neuralmagic.com)
## Website
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
### Installation
```
$ yarn
```
### Local Development
```
$ yarn start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build
```
$ yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
Using SSH:
```
$ USE_SSH=true yarn deploy
```
Not using SSH:
```
$ GIT_USER= yarn deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.