• L.S. Cook's avatar
    Doc 0.11 (#2219) · 9940123b
    L.S. Cook authored
    * editing docs
    
    * more doc updates
    
    * Cleanup theme, update backends for PlaidML, remove stale font
    
    * Add PlaidML description and doc update that should have been added with PR 1888
    
    * Add PlaidML description and doc update that should have been added with PR 1888
    
    * Latest release doc updates
    
    * Add PlaidML description and doc update for PR 1888
    * Update glossary with tensor description and quantization def
    * Refactor landpage with QuickStart guides
    * Add better details about nGraph features and roadmap
    
    * Placeholder detail for comparison section
    
    * Add section link
    
    * order sections alphabetically for now
    
    * update compiler illustration
    
    * Address feedback from doc review
    
    * Update illustration wording
    
    * Formatting and final edits
    
    * keep tables consistent
    
    * Clarify doc on bridge and compiler docs
    
    * Clarify doc on bridge and compiler docs
    
    * yay for more feedback and improvements
    
    * edit with built doc
    
    * Fix typo
    
    * Another phase of PR review editing
    
    * Final review comment resolved
    
    * note grammatically-correct wording preferred as often as possible.
    
    * First iteration of shared subgraphs with onnx doc
    
    * Updte onnx wheel install instructions with latest ngraph-0.9.0 versioning
    
    * Updte onnx wheel install instructions with latest ngraph-0.9.0 versioning
    
    * Update section  on subgraphs and shared subgraph docs
    
    * Finalize edit of mxnet tutorial given status of our PR
    
    * Make sure latest conf py is being used
    
    * Update to latest index
    
    * Add link to design doc mentioned by Ashoke and update about for consistent headings
    
    * Update with PR feedback
    
    * Update with new pip install instructions
    
    * add more testing
    
    * Further feedback review included
    
    * Improve descriptions, given the new pip pkg install options
    
    * Add note to onnx_ssg_tutorial
    
    * Links updated to latest correct url
    
    * Improve docs for Beta
    
    * Reorganize TOC
    
    * Better org in sections
    
    * Make heading style consistent across indexes
    
    * Update intro to framework builders
    
    * Update intro to framework builders
    
    * Add feedback from reviewers
    
    * Minor fixes to ToC and editing
    
    * Add section on FMV for miscellaneous use cases
    
    * Update notice on README
    
    * Updte link to howto index
    
    * fix typo
    
    * fix note
    
    * Update glossary
    9940123b
README.md 6.63 KB

nGraph Compiler Stack (Beta)

License Build Status

Quick start

To begin using nGraph with popular frameworks to accelerate deep learning workloads on CPU for inference, please refer to the links below.

Framework (Version) Installation guide Notes
TensorFlow* 1.12 Pip install or Build from source 20 Validated workloads
MXNet* 1.3 Pip install or Build from source 18 Validated workloads
ONNX 1.3 Pip install 14 Validated workloads

:exclamation: :exclamation: :exclamation: Note that the pip package option works only with Ubuntu 16.04 or greater and Intel:registered: Xeon:registered: CPUs. CPUs without Intel:registered: Advanced Vector Extensions 512 (Intel:registered: AVX-512) will not run these packages; the alternative is to build from source. Wider support for other CPUs will be offered starting in early 2019 :exclamation: :exclamation: :exclamation:

Frameworks using nGraph Compiler stack to execute workloads have shown up to 45X performance boost when compared to native framework implementations. We've also seen performance boosts running workloads that are not included on the list of Validated workloads, thanks to our powerful subgraph pattern matching.

Additional work is also being done via PlaidML which will feature running compute for Deep Learning with GPU accleration. See our Architecture and features for what the stack looks like today and watch our Release Notes for recent changes.

What is nGraph Compiler?

nGraph Compiler aims to accelerate developing and deploying AI workloads using any deep learning framework with a variety of hardware targets. We strongly believe in providing freedom, performance, and ease-of-use to AI developers.

The diagram below shows what deep learning frameworks and hardware targets we support. More details on these current and future plans are in the ecosystem section.

nGraph wireframe

While the ecosystem shown above is all functioning, we have validated performance for deep learning inference on CPU processors such as Intel:registered: Xeon:registered:. Please refer to the Release notes to learn more. The Gold release is targeted for April 2019; it will feature broader workload coverage, including quantized graphs, and more detail on our advanced support for int8.

Our documentation has extensive information about how to use nGraph Compiler stack to create an nGraph computational graph, integrate custom frameworks, and to interact with supported backends. If you wish to contribute to the project, please don't hesitate to ask questions in GitHub issues after reviewing our contribution guide below.

How to contribute

We welcome community contributions to nGraph. If you have an idea how to improve it:

  • See the contrib guide for code formatting and style guidelines.
  • Share your proposal via GitHub issues.
  • Ensure you can build the product and run all the examples with your patch.
  • In the case of a larger feature, create a test.
  • Submit a pull request.
  • Make sure your PR passes all CI tests. Note: our Travis-CI service runs only on a CPU backend on Linux. We will run additional tests in other environments.
  • We will review your contribution and, if any additional fixes or modifications are necessary, may provide feedback to guide you. When accepted, your pull request will be merged to the repository.