Skip to content

Latest commit

 

History

History
111 lines (79 loc) · 5.8 KB

README.md

File metadata and controls

111 lines (79 loc) · 5.8 KB

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.

Documentation Contributor Covenant

Our Documentation website 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 Repo Queue Index Apache 2.0
Sparsify Repo Queue Index Apache 2.0
SparseZoo Repo Queue Index Apache 2.0
DeepSparse Community Repo Queue Index Neural Magic DeepSparse Community
DeepSparse Enterprise - Queue Index MSLSA (Enterprise)

For user help or questions, sign up or log in to our Neural Magic 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 Queues for the related repository.

To contribute to Neural Magic documentation, please:

Open a GitHub issue and give it the documentation label.
Submit a pull request with your proposed documentation changes.
Get started with writing and formatting on GitHub.

To learn more about Neural Magic, check our website.

Website

This website is built using Docusaurus, 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=<Your GitHub username> 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.