{"id":19023712,"url":"https://github.com/neuralmagic/docs","last_synced_at":"2025-04-05T07:04:48.869Z","repository":{"id":37366048,"uuid":"328822877","full_name":"neuralmagic/docs","owner":"neuralmagic","description":"Top-level directory for documentation and general content","archived":false,"fork":false,"pushed_at":"2024-11-25T22:20:55.000Z","size":786498,"stargazers_count":120,"open_issues_count":4,"forks_count":7,"subscribers_count":22,"default_branch":"main","last_synced_at":"2025-03-29T06:05:52.861Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://docs.neuralmagic.com/","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/neuralmagic.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-01-12T00:00:04.000Z","updated_at":"2025-03-22T07:02:10.000Z","dependencies_parsed_at":"2024-04-08T18:47:01.653Z","dependency_job_id":"38fe9861-2656-4c40-8b46-8478a65a96c2","html_url":"https://github.com/neuralmagic/docs","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neuralmagic%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neuralmagic%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neuralmagic%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neuralmagic%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/neuralmagic","download_url":"https://codeload.github.com/neuralmagic/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247299831,"owners_count":20916190,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T20:32:19.402Z","updated_at":"2025-04-05T07:04:48.850Z","avatar_url":"https://github.com/neuralmagic.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!--\nCopyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing,\nsoftware distributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n--\u003e\n\n\u003cdiv align=\"center\"\u003e\u003ch2\u003eNeural Magic Documentation\u003c/h2\u003e\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n\u003cp\u003eThe Neural Magic Platform provides a suite of software components to select, build, and run performant\u003cbr\u003e\n    deep learning models on CPU resources.\u003c/p\u003e\n\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://docs.neuralmagic.com/\"\u003e\n        \u003cimg alt=\"Documentation\" src=\"https://img.shields.io/website/http/docs.neuralmagic.com/index.html.svg?down_color=red\u0026down_message=offline\u0026up_message=online\u0026style=for-the-badge\" height=25\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/neuralmagic/docs/blob/main/CODE_OF_CONDUCT.md\"\u003e\n        \u003cimg alt=\"Contributor Covenant\" src=\"https://img.shields.io/badge/Contributor%20Covenant-v2.1%20adopted-ff69b4.svg?color=yellow\u0026style=for-the-badge\" height=25\u003e\n    \u003c/a\u003e\n     \u003ca href=\"https://www.youtube.com/channel/UCo8dO_WMGYbWCRnj_Dxr4EA\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/-YouTube-red?\u0026style=for-the-badge\u0026logo=youtube\u0026logoColor=white\" height=25\u003e\n    \u003c/a\u003e\n     \u003ca href=\"https://medium.com/limitlessai\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/medium-%2312100E.svg?\u0026style=for-the-badge\u0026logo=medium\u0026logoColor=white\" height=25\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://twitter.com/neuralmagic\"\u003e\n        \u003cimg src=\"https://img.shields.io/twitter/follow/neuralmagic?color=darkgreen\u0026label=Follow\u0026style=social\" height=25\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n  \n[Our Documentation website](https://docs.neuralmagic.com/) is a great starting point. To learn more about specific Neural Magic products, review the links below.\n\nTo file a documentation issue for a specific software component, use its repo issue tracker.\n\n| Docs                                                          | GitHub                                             | Issue Tracker                                              | Releases                                                     | License             |\n| ------------------------------------------------------------- | -------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | ------------------- |\n| [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          |\n| [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          |\n| [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          |\n| [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/) |\n| [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/) |\n\nFor 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.\n\nTo contribute to Neural Magic documentation, please:\u003c/br\u003e\n\n  Open a [GitHub issue](https://github.com/neuralmagic/docs/issues/) and give it\n  the `documentation` label.\u003c/br\u003e\n  Submit a [pull request](https://github.com/neuralmagic/docs/pulls/) with your\n  proposed documentation changes.\u003c/br\u003e\n  Get started with\n  [writing and formatting on GitHub.](https://help.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github)\n  \n  To learn more about Neural Magic, [check our website.](https://www.neuralmagic.com)\n\u003c/div\u003e\n\n \u003c/div\u003e\n\n## Website\n\nThis website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.\n\n### Installation\n\n```\n$ yarn\n```\n\n### Local Development\n\n```\n$ yarn start\n```\n\nThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.\n\n### Build\n\n```\n$ yarn build\n```\n\nThis command generates static content into the `build` directory and can be served using any static contents hosting service.\n\n### Deployment\n\nUsing SSH:\n\n```\n$ USE_SSH=true yarn deploy\n```\n\nNot using SSH:\n\n```\n$ GIT_USER=\u003cYour GitHub username\u003e yarn deploy\n```\n\nIf you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneuralmagic%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fneuralmagic%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneuralmagic%2Fdocs/lists"}